# General Information
We highly recommend consulting the API documentation for comprehensive information regarding request structures, response formats, and other pertinent details. Please be aware that our API imposes a payload size limit of 10 MB. Should the payload exceed this threshold, including any attachments, an error will be generated, and the server will not process the request. To circumvent this limitation, users are advised to divide their payload into smaller segments and submit these portions in separate requests.
Vroozi API v1_1.4.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Vroozi API Documentation
Base URLs:
New Documentation
Release Notes (December 2024)
## Overview of Version 1_1.4.0 Enhancements
New Features:
- Async bulk upsert APIs:
We are excited to announce the availability of master data bulk upsert functionalities through our open APIs. For further information, please refer to the “Master Data APIs” section within our documentation.
- Bug Fixes: Resolved various issues to enhance system stability and reliability.
Authentication
Vroozi API uses a combination of API key and Access Token values to allow access to the API.
The API Key/Access Token can be generated by an Admin user on Purchasing Manager, under the API Integration section.
If you need help obtaining your API Key/Access Token, please contact Vroozi Support.
Vroozi API expects both an API Key and an Access Token to be included in all API requests using headers like the following:
x-api-key: SaRCADi2Rj0uQiesJ943Q9SYHmyMYMzZzk6HXul2
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJBUFBfSUQiOiI0MmI2NDFlYS1jZTI2LTQ0MGQtYjJmZC03NjNlZmJlMjRjY2YiLCJVTklUX0lEIjoiMiIsIlJBTkRPTV9OVU1CRVIiOiJiYjM3OGMwNS1hZjk3LTQ5MGUtOGIxYS01OGZiY2MzNDE2YTkifQ.98XTUPrReAhbczTAbOjl_3EVHOHqo9Eb4oozkP79xuCizBl-Bkc_-BKAISWKYgf4oHBeD9JKY6kvTgphqPFzyw
Partner Authentication
Partner can send API access request by sending an email to support@vroozi.com. Once the request is approved, Vroozi Team will share credential details which can be used to access API.
Partner App should use the provided credentials in every request to access the API endpoints. Below is the example of how the credentials can be configured.
Each request should contain the following headers:
x-api-key: SaRCADi2Rj0uQiesJ943Q9SYHmyMYMzZzk6HXul2
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJBUFBfSUQiOiI0MmI2NDFlYS1jZTI2LTQ0MGQtYjJmZC03NjNlZmJlMjRjY2YiLCJVTklUX0lEIjoiMiIsIlJBTkRPTV9OVU1CRVIiOiJiYjM3OGMwNS1hZjk3LTQ5MGUtOGIxYS01OGZiY2MzNDE2YTkifQ.98XTUPrReAhbczTAbOjl_3EVHOHqo9Eb4oozkP79xuCizBl-Bkc_-BKAISWKYgf4oHBeD9JKY6kvTgphqPFzyw
unitId: Vroozi-unitId
vzi-partner-code: Vroozi-Partner
Webhooks
Webhooks Configuration
Webhooks allow you to set up your interface to subscribe for certain events that occur in Vroozi Application. When one of those events is triggered, we’ll send a HTTP POST request with event payload to the webhook’s configured URL. Webhooks can be used to listen for an event such as Purchase Request Submission, Purchase Order Confirmation, Invoice Posting and more.
Webhooks can be configured in Vroozi Admin portal as shown below.
Go to the Webhooks page under API Integration from navigation bar of Vroozi.
Add new webhook configuration using the Add New Webhook button, a modal will appear.
Respective modal closes and the webhook settings is created as shown below:
Events
When configuring a webhook, you can choose which events you would like to receive the notification for. We recommend subscribing to the specific events you plan on handling with your integration. This will help limit the number of HTTP requests to your server. You can change the list of subscribed events through the Vroozi Admin portal anytime as shown above.
Each event corresponds to a certain set of actions that can happen in Vroozi Application.
For example, if you subscribe to the Purchase Request > Approved event you’ll receive the event notification whenever a Purchase Request is Approved in Vroozi.
The available events are:
| Entity | Events | |||||||
|---|---|---|---|---|---|---|---|---|
| Goods Receipt | Confirmed | |||||||
| Good Return | Confirmed | |||||||
| Purchase Order | Confirmed | Ordered | Processing | |||||
| Invoice | Posting | Posted | ||||||
| Memo | Posting | Posted | ||||||
| Purchase Request | Pending | Approved | Submitted | |||||
| Payment Request | Pending | Approved | Rejected | Posting | Posted | Posting Failed | Cancelled | Deleted |
Payload
All event type has a generic payload format with the relevant event information. It includes the references to the actual data along with the user who performed the event, source of where the event occurred (if applicable). For example, see a sample payload for Purchase Request Approved event below.
Payload Data Model:
See EventModel in the Models section for more details
How to implement Webhooks endpoint?
- The endpoint should support HTTPS protocol with POST Method.
- The endpoint should accept the JSON request payload as provided above.
- The endpoint should return 200 OK for success and 4xx/5xx for error with appropriate error message (if applicable)
Accounting Strings
Get List of Accounting Strings
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/accounting-combos \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/accounting-combos', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/accounting-combos',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounting-combos
Get list of Accounting Strings.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of accounting strings requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings. |
AccountingComboPageModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Some of the referenced object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create the Accounting Strings
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/accounting-combos \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/accounting-combos', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/accounting-combos',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounting-combos
Create Accounting Strings
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AccountingComboModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Accounting Strings created successfully. |
AccountingComboModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Some Resources couldn’t be found. |
ErrorDataModel |
409 |
Accounting Strings data contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create or update the Accounting Strings
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/accounting-combos/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/accounting-combos/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/accounting-combos/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounting-combos/upsert
Create or update the Accounting Strings.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AccountingComboModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings updated successfully. |
AccountingComboModel |
201 |
Accounting Strings created successfully. |
AccountingComboModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Some of the resources couldn’t be found. |
ErrorDataModel |
409 |
Accounting Strings Data Contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create or update the bulk Accounting Strings
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/accounting-combos/bulk-upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/bulk-upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos/bulk-upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/accounting-combos/bulk-upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/accounting-combos/bulk-upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounting-combos/bulk-upsert
Create or update the bulk Accounting Strings.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body AccountingComboListModelrequired |
body | No description |
Example responses
[
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings created or updated successfully. |
AccountingComboListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Some of the resources couldn’t be found. |
ErrorDataModel |
409 |
Accounting Strings Data Contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Async Bulk Upload Status By Request Id
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/accounting-combos/bulk-upsert/{requestId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/bulk-upsert/{requestId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos/bulk-upsert/{requestId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/accounting-combos/bulk-upsert/{requestId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/accounting-combos/bulk-upsert/{requestId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounting-combos/bulk-upsert/{requestId}/status
Async Bulk Upload Status of Accounting Strings By Request Id
Parameters
| Parameter | In | Description |
|---|---|---|
requestId stringrequired |
path | No description |
Example responses
{
"requestId": "5abb-d758e6-1c824a",
"status": "IN_PROGRESS",
"updates": {
"total": 10,
"success": 5,
"failed": 5
},
"payload": [
{
"accountingCombo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "SUCCESS"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of Async Bulk Upload request. |
AsyncBulkUploadStatusModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Accounting Strings or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create or update the bulk Accounting Strings asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/accounting-combos/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"payload": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/accounting-combos/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/accounting-combos/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/accounting-combos/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounting-combos/bulk-upsert/async
Upsert Accounting Strings asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
{
"payload": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AsyncBulkUploadRequestModelrequired |
body | No description |
Example responses
{
"requestId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
Bulk upload received successfully |
AsyncBulkUploadResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Accounting Strings or any of the reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Accounting Strings By ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/accounting-combos/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/accounting-combos/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/accounting-combos/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/accounting-combos/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounting-combos/{id}
Get Accounting Strings by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings returned. |
AccountingComboModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Accounting Strings or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Accounting Strings
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/accounting-combos/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/accounting-combos/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/accounting-combos/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/accounting-combos/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /accounting-combos/{id}
Update accounting Strings by Id or externalId.
You can either provide system generated Id or externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | ID can be either internal Vroozi ID or External System ID. If using externalId, the header key useExternalId should be passed as true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body AccountingComboModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings has been updated. |
AccountingComboModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Accounting Strings or any referenced resources couldn’t be found. |
ErrorDataModel |
409 |
Accounting Strings Data Contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Accounting Strings By ID
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/accounting-combos/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/accounting-combos/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/accounting-combos/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/accounting-combos/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/accounting-combos/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /accounting-combos/{id}
Delete Accounting Strings by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Accounting Strings deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Accounting Strings or any of the reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Addresses
Create Address
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/addresses \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/addresses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/addresses',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/addresses', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/addresses',
params: {
}, headers: headers
p JSON.parse(result)
POST /addresses
Create new address
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AddressModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Address is created successfully. |
AddressModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
409 |
Address contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
List Addresses
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/addresses \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/addresses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/addresses',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/addresses', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /addresses
Get the list of addresses
If the lastUpdatedAfter query parameters is provided, then it will return the list of suppliers updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of addresses. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address list fetched. |
AddressListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Address
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/addresses/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/addresses/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/addresses/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/addresses/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/addresses/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /addresses/upsert
Create/Update Address
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AddressModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address is updated successfully. |
AddressModel |
201 |
Address is created successfully. |
AddressModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
409 |
Address contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Address
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/addresses/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/addresses/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/addresses/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /addresses/{id}
Get address by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address returned. |
AddressModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Address
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/addresses/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/addresses/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/addresses/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /addresses/{id}
Update address by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
body AddressModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address is updated successfully. |
AddressModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
409 |
Address contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Address
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/addresses/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/addresses/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/addresses/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /addresses/{id}
Delete address by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address has been deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Address by AddressID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/addresses/address-id/{addressId} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/addresses/address-id/{addressId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/addresses/address-id/{addressId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/addresses/address-id/{addressId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/addresses/address-id/{addressId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /addresses/address-id/{addressId}
Get address by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
addressId stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Address returned. |
AddressModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Address or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Approval Groups
List Approval Groups
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/approval-groups \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/approval-groups', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/approval-groups',
params: {
}, headers: headers
p JSON.parse(result)
GET /approval-groups
Query all approval groups.
If the lastUpdatedAfter parameter is provided, then it will return the list of approval group updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of approval group. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Approval Groups list returned. |
ApprovalGroupListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Approval Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/approval-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/approval-groups', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/approval-groups',
params: {
}, headers: headers
p JSON.parse(result)
POST /approval-groups
Create a new Approval Group
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ApprovalGroupModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Approval Group has been created. |
ApprovalGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Approval Group id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Approval Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/approval-groups/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/approval-groups/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/approval-groups/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /approval-groups/upsert
Create/Update Approval Group
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ApprovalGroupModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Approval Group is updated successfully. |
ApprovalGroupModel |
201 |
Approval Group is created successfully. |
ApprovalGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Approval Group or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Approval Group contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Bulk Upsert Approval Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/approval-groups/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/approval-groups/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/approval-groups/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /approval-groups/bulk-upsert/async
This endpoint allows for the creation or updating of multiple approval groups in a single asynchronous bulk upsert request.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The approval group bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Bulk Upsert Approval Group Retry
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/approval-groups/bulk-upsert/async/retry?trackingId=string \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/bulk-upsert/async/retry?trackingId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups/bulk-upsert/async/retry?trackingId=string',
{
method: 'POST',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/approval-groups/bulk-upsert/async/retry', params={
'trackingId': 'string'
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/approval-groups/bulk-upsert/async/retry',
params: {
'trackingId' => 'string'
}, headers: headers
p JSON.parse(result)
POST /approval-groups/bulk-upsert/async/retry
This endpoint allows you to re-trigger the failed asynchronous bulk upsert request.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
query | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The approval group bulk upsert async retry request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Retrieve Async Bulk Upload Status by trackingId
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/approval-groups/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/approval-groups/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/approval-groups/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/approval-groups/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /approval-groups/bulk-upsert/{trackingId}/status
Retrieve the status of an asynchronous bulk upload request for approval groups using the provided trackingId.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/approval-groups/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "APPROVAL_GROUP",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "ERROR"
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of Async Bulk Upload request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Approval Group
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/approval-groups/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/approval-groups/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/approval-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/approval-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /approval-groups/{id}
Get Approval Group by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Approval Group returned |
ApprovalGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Approval Group id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Approval Group
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/approval-groups/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/approval-groups/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/approval-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/approval-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /approval-groups/{id}
Update approval group by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body ApprovalGroupModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Approval Group has been updated. |
ApprovalGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Approval Group id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Approval Group
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/approval-groups/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/approval-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/approval-groups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/approval-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/approval-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /approval-groups/{id}
Delete Approval Group by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Approval Group object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Approval Group not found |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Async Request Tracking
Get progress status of async request by Tracking id.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/async-requests/{trackingId} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/async-requests/{trackingId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/async-requests/{trackingId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/async-requests/{trackingId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/async-requests/{trackingId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /async-requests/{trackingId}
Progress status of async request by Tracking Id
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "status-update",
"requestMethod": "status-update",
"docType": "InvoiceModel",
"processingResult": {
"metadata": {
"payloadRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AttachmentModel",
"label": "Description for label",
"archived": false
},
"invoiceNumber": "9000001616",
"externalId": "20010001",
"vendorInvoiceNumber": "123456789"
},
"status": "SUCCESS",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"warnings": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
A representation of Async request’s progress status. |
VrooziApiAsyncRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Async Request is not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Attachments
Download Attachment
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/attachment/{id} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/attachment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/attachment/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/attachment/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/attachment/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /attachment/{id}
Download attachment by ID
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Image Id |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
200 OK |
None |
400 |
Bad request! Something went wrong. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Attachment id not found. |
ErrorDataModel |
500 |
Something went wrong. Details: Actual error message |
ErrorDataModel |
Upload Attachment
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/attachment \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: multipart/form-data'
URL obj = new URL("https://api.vroozi.com/v1/attachment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"file": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'multipart/form-data'
};
fetch('https://api.vroozi.com/v1/attachment',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'multipart/form-data'
}
r = requests.post('https://api.vroozi.com/v1/attachment', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'multipart/form-data'
}
result = RestClient.post 'https://api.vroozi.com/v1/attachment',
params: {
}, headers: headers
p JSON.parse(result)
POST /attachment
Upload new attachment
Body parameter
file: string
Parameters
| Parameter | In | Description |
|---|---|---|
body object |
body | No description |
file string(binary)required |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
AttachmentModel has been created. |
AttachmentModel |
400 |
Bad request! Something went wrong. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Attachment or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Details: Actual error message |
ErrorDataModel |
Budgets
List Budgets
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/budgets \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/budgets', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/budgets',
params: {
}, headers: headers
p JSON.parse(result)
GET /budgets
Get the list of budgets
If the lastUpdatedAfter parameter is provided, then it will return the list of budgets updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000 , 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of budgets. Max page size limit: 50
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
200 OK |
BudgetListModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Budget
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/budgets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/budgets', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/budgets',
params: {
}, headers: headers
p JSON.parse(result)
POST /budgets
Create new Budget.
You must supply the required field values in the POST request.
The response body will return the newly created payment term with generated ID.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body BudgetModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Budget is created successfully. |
BudgetModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Budget
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/budgets/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'association-update-strategy: REPLACE'
URL obj = new URL("https://api.vroozi.com/v1/budgets/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'association-update-strategy':'REPLACE'
};
fetch('https://api.vroozi.com/v1/budgets/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'association-update-strategy': 'REPLACE'
}
r = requests.post('https://api.vroozi.com/v1/budgets/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'association-update-strategy' => 'REPLACE'
}
result = RestClient.post 'https://api.vroozi.com/v1/budgets/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /budgets/upsert
Create/Update Budget
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
association-update-strategy string |
header | Update strategy of Budget. |
body BudgetModelrequired |
body | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| association-update-strategy | REPLACE |
| association-update-strategy | MERGE |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget is updated successfully. |
BudgetModel |
201 |
Budget is created successfully. |
BudgetModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Budget contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Budget
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/budgets/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/budgets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/budgets/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/budgets/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/budgets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /budgets/{id}
Get Budget by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Successfully returned the Budget object. |
BudgetModel |
400 |
Bad request! Something went wrong. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Budget using Merge
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/budgets/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/budgets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/budgets/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/budgets/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/budgets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
POST /budgets/{id}
Update budget by ID. It will merge the new associations with existing association on the budget.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | ID value |
body BudgetModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget is updated successfully. |
BudgetModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Budget
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/budgets/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/budgets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/budgets/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/budgets/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/budgets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /budgets/{id}
Update budget by ID. It will replace the associations on the existing budget.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | ID value |
body BudgetModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget is updated successfully. |
BudgetModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Budget
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/budgets/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/budgets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/budgets/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/budgets/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/budgets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /budgets/{id}
Delete Budget by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The response will be 200 OK in case of successful deletion. You won’t be able to retrieve this data once deleted.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget object has been deleted. |
None |
400 |
Bad request! Something went wrong. See error message for more details. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Budget id not found. |
ErrorDataModel |
500 |
Something went wrong |
ErrorDataModel |
Delete Budget association
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/budgets/{id}/associations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/budgets/{id}/associations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/budgets/{id}/associations',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/budgets/{id}/associations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/budgets/{id}/associations',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /budgets/{id}/associations
Delete Budget Associations using Budget ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The response will be 200 OK in case of successful deletion. Deleting all the associations on the delete association end point should delete budget as well.
Body parameter
[
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
body BudgetAssociationListModelrequired |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget Associations has been deleted. |
None |
400 |
Bad request! Something went wrong. See error message for more details. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Budget id not found. |
ErrorDataModel |
500 |
Something went wrong |
ErrorDataModel |
Get Budget by name
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/budgets/name/{name} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets/name/{name}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/budgets/name/{name}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/budgets/name/{name}',
params: {
}, headers: headers
p JSON.parse(result)
GET /budgets/name/{name}
Get Budget by name
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the budget |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Successfully returned the Budget object. |
BudgetModel |
400 |
Bad request! Something went wrong. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Budget id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Budget association using budget name
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/budgets/name/{name}/associations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets/name/{name}/associations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets/name/{name}/associations',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.delete('https://api.vroozi.com/v1/budgets/name/{name}/associations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.vroozi.com/v1/budgets/name/{name}/associations',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /budgets/name/{name}/associations
Delete Budget Associations using budget name.
The response will be 200 OK in case of successful deletion. Deleting all the associations on the delete association end point should delete budget as well.
Body parameter
[
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the budget |
body BudgetAssociationListModelrequired |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Budget Associations has been deleted. |
None |
400 |
Bad request! Something went wrong. See error message for more details. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Budget id not found. |
ErrorDataModel |
500 |
Something went wrong |
ErrorDataModel |
Update budget status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/budgets/status-update/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets/status-update/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"budgetRefs": [
{
"type": "BudgetModel"
}
],
"active": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets/status-update/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/budgets/status-update/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/budgets/status-update/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /budgets/status-update/async
Update budget status.
Body parameter
{
"budgetRefs": [
{
"type": "BudgetModel"
}
],
"active": true
}
Parameters
| Parameter | In | Description |
|---|---|---|
body StatusUpdateRequestModelrequired |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
Budget status update request is accepted. The request is under process. Use the request tracking API with the trackingId you received to track the progress. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Budget or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get progress status of async request by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/budgets/async-requests/{trackingId} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/budgets/async-requests/{trackingId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/budgets/async-requests/{trackingId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/budgets/async-requests/{trackingId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/budgets/async-requests/{trackingId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /budgets/async-requests/{trackingId}
Progress status of async request by Tracking Id
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"processingResult": [
{
"payload": {
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"active": true
},
"status": "SUCCESS",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"warnings": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
],
"updates": {
"total": 10,
"success": 5,
"unchanged": 5,
"failed": 5
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
A representation of Async request’s progress status. |
AsyncRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Async Request is not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Catalog Items
Get List of Catalog Items by Catalog ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/{id}/items \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/items',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/{id}/items', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/{id}/items',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/{id}/items
Get list of catalog items from a given catalog id.
You can either provide system generated ID or your provided externalId..
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true..
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by externalId..
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Additionally an operator can be provided with the date to select the records for the selected filters. We support following formats for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is explained in the paramter description.
You can also provide the page and size to get the desired list of published catalog items. Max page size limit: 500.
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id of the catalog |
useExternalId string |
header | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are filtering the item by catalog externalId. In such cases combination of catalog externalId and version will uniquely identify the catalog. |
lastUpdated string |
query | Updated date to filter list. |
status array[string] |
query | Status of catalog |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are filtering the item by catalog externalId. In such cases combination of catalog externalId and version will uniquely identify the catalog.
lastUpdated: Updated date to filter list.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Our API supports a special format for date filters, allowing you to use different operators to obtain the desired results.
The following formats are supported for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is as follows:
eq (Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated on the specified date will be filtered.
Examples: eq(2024-02-05T00:00:00.000-0000), eq(2024-02-05T00:00:00.000) will filter all records updated on the specified date.
gt (Greater Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after the specified date will be filtered.
Examples: gt(2024-02-05T00:00:00.000-0000), gt(2024-02-05T00:00:00.000), gt(2024-02-05T00:00:00-0000), gt(2024-02-05T00:00:00), gt(2024-02-05) will filter all records updated after the specified date.
gte (Greater Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after and including the specified date will be filtered.
Examples: gte(2024-02-05T00:00:00.000-0000), gte(2024-02-05T00:00:00.000), gte(2024-02-05T00:00:00-0000), gte(2024-02-05T00:00:00), gte(2024-02-05) will filter all records updated after or on the specified date.
lt (Less Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before the specified date will be filtered.
Example: lt(2024-02-05T00:00:00.000-0000), lt(2024-02-05T00:00:00.000), lt(2024-02-05T00:00:00-0000), lt(2024-02-05T00:00:00), lt(2024-02-05) will filter all records updated before the specified date.
lte (Less Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before and including the specified date will be filtered.
Examples: lte(2024-02-05T00:00:00.000-0000), lte(2024-02-05T00:00:00.000), lte(2024-02-05T00:00:00-0000), lte(2024-02-05T00:00:00), lte(2024-02-05) will filter all records updated before or on the specified date.
btw (Between)
Description: Accepts two dates as parameters (both are required).
Behavior: When this operator is selected, all records updated between the specified start and end dates will be filtered.
Examples: btw(2024-02-05T00:00:00.000-0000, 2024-02-06T00:00:00.000-0000), btw(2024-02-05T00:00:00.000, 2024-02-06T00:00:00.000), btw(2024-02-05T00:00:00-0000, 2024-02-06T00:00:00-0000), btw(2024-02-05T00:00:00, 2024-02-06T00:00:00), btw(2024-02-05, 2024-02-06) will filter all records updated between the specified dates.
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| status | APPROVED |
| status | PUBLISHED |
| status | REJECTED |
| status | PENDING_APPROVAL |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog Items list returned. |
CatalogItemListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get List of Catalog Items by Catalog Name
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/name/{name}/items \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/items',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/name/{name}/items', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/name/{name}/items',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/name/{name}/items
Get list of catalog items by catalog name with filters.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by name.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Additionally an operator can be provided with the date to select the records for the selected filters. We support following formats for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is explained in the paramter description.
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the catalog |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are filtering the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
lastUpdated string |
query | Updated date to filter list. |
status array[string] |
query | Status of catalog |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are filtering the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
lastUpdated: Updated date to filter list.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Our API supports a special format for date filters, allowing you to use different operators to obtain the desired results.
The following formats are supported for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is as follows:
eq (Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated on the specified date will be filtered.
Examples: eq(2024-02-05T00:00:00.000-0000), eq(2024-02-05T00:00:00.000) will filter all records updated on the specified date.
gt (Greater Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after the specified date will be filtered.
Examples: gt(2024-02-05T00:00:00.000-0000), gt(2024-02-05T00:00:00.000), gt(2024-02-05T00:00:00-0000), gt(2024-02-05T00:00:00), gt(2024-02-05) will filter all records updated after the specified date.
gte (Greater Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after and including the specified date will be filtered.
Examples: gte(2024-02-05T00:00:00.000-0000), gte(2024-02-05T00:00:00.000), gte(2024-02-05T00:00:00-0000), gte(2024-02-05T00:00:00), gte(2024-02-05) will filter all records updated after or on the specified date.
lt (Less Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before the specified date will be filtered.
Example: lt(2024-02-05T00:00:00.000-0000), lt(2024-02-05T00:00:00.000), lt(2024-02-05T00:00:00-0000), lt(2024-02-05T00:00:00), lt(2024-02-05) will filter all records updated before the specified date.
lte (Less Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before and including the specified date will be filtered.
Examples: lte(2024-02-05T00:00:00.000-0000), lte(2024-02-05T00:00:00.000), lte(2024-02-05T00:00:00-0000), lte(2024-02-05T00:00:00), lte(2024-02-05) will filter all records updated before or on the specified date.
btw (Between)
Description: Accepts two dates as parameters (both are required).
Behavior: When this operator is selected, all records updated between the specified start and end dates will be filtered.
Examples: btw(2024-02-05T00:00:00.000-0000, 2024-02-06T00:00:00.000-0000), btw(2024-02-05T00:00:00.000, 2024-02-06T00:00:00.000), btw(2024-02-05T00:00:00-0000, 2024-02-06T00:00:00-0000), btw(2024-02-05T00:00:00, 2024-02-06T00:00:00), btw(2024-02-05, 2024-02-06) will filter all records updated between the specified dates.
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| status | APPROVED |
| status | PUBLISHED |
| status | REJECTED |
| status | PENDING_APPROVAL |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog Items list returned. |
CatalogItemListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Catalog Item by Catalog ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/{id}/items/{itemId} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/items/{itemId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/items/{itemId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/{id}/items/{itemId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/{id}/items/{itemId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/{id}/items/{itemId}
Get catalog item from a given Catalog id and Item Id.
You can either provide system generated ID or your provided externalId with Item Id.
When passing externalId as a catalog id in the request url, its required to send the request header useExternalId with value of true.
When passing externalId true and catalog expect to have multiple versions then it is required to send version number in the request query param
Note: When setting useExternalId to true, ensure that externalId is passed for both the catalog and the catalog item.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
itemId stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are getting the item by catalog external id. In such cases combination of catalog external id and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are getting the item by catalog external id. In such cases combination of catalog external id and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog Item returned. |
CatalogItemModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Uploads items to the Catalog by ID
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/{id}/items/upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string' \
-H 'update-strategy: REPLACE'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/items/upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"payload": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string',
'update-strategy':'REPLACE'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/items/upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string',
'update-strategy': 'REPLACE'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/{id}/items/upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string',
'update-strategy' => 'REPLACE'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/{id}/items/upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/{id}/items/upsert/async
Uploads items to the Catalog.
You can either provide system generated Id or user provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The payload size of the Request Body should not exceed the limit of 10 MB There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by catalog name.
Body parameter
{
"payload": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | No description |
useExternalId string |
header | No description |
version number |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
update-strategy string |
header | Update strategy of catalog items. |
body |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Enumerated Values
| Parameter | Value |
|---|---|
| update-strategy | REPLACE |
| update-strategy | MERGE |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
Item Upload request is accepted. The request is under process. Use the request tracking API with the trackingId you received to track the progress. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Catalog with multiple version exists. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Uploads catalog items to the Catalog by Name
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/name/{name}/items/upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'update-strategy: REPLACE'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/items/upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"payload": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'update-strategy':'REPLACE'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/items/upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'update-strategy': 'REPLACE'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/name/{name}/items/upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'update-strategy' => 'REPLACE'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/name/{name}/items/upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/name/{name}/items/upsert/async
Uploads items to the Catalog.
The payload size of the Request Body should not exceed the limit of 10 MB There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by catalog externalId.
Body parameter
{
"payload": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version number |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog externalId. In such cases combination of catalog externalId and version will uniquely identify the catalog. |
update-strategy string |
header | Update strategy of catalog items. |
body |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog externalId. In such cases combination of catalog externalId and version will uniquely identify the catalog.
Enumerated Values
| Parameter | Value |
|---|---|
| update-strategy | REPLACE |
| update-strategy | MERGE |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
Item Upload request is accepted. The request is under process. Use the request tracking API with the trackingId you received to track the progress. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Catalog with multiple version exists. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Catalog Item by Catalog Name
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/name/{name}/items/{itemId} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/items/{itemId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/items/{itemId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/name/{name}/items/{itemId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/name/{name}/items/{itemId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/name/{name}/items/{itemId}
Get catalog item from a given Catalog name and Item Id.
When passing name and catalog expect to have multiple versions then it is required to send version number in the request query param
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
name stringrequired |
path | No description |
itemId stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are getting the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are getting the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog Item returned. |
CatalogItemModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Catalog Items File Upload
Upload Catalog Items using file
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/name/{name}/upload \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"resourceFile": "string",
"imageFile": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/upload',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/name/{name}/upload', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/name/{name}/upload',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/name/{name}/upload
To add catalog items to an existing catalog, use the provided template. The upload process is asynchronous, allowing you to continue other tasks without interruption. Ensure your catalog data is saved in supported formats: [.csv, .tsv, .xlsx, .zip, or .war]. Fill in the template with your item details, and upload the file. You can additionally provide the image file to associate with each item in the file. If you encounter any issues, refer to the documentation or reach out to the system administrator for assistance.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when uploading items.
Body parameter
resourceFile: string
imageFile: string
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
body object |
body | No description |
resourceFile string(binary)required |
body | No description |
imageFile string(binary)required |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Provided file is uploaded successfully. The file will be processed asynchronously. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Catalogs
Create Catalog
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/catalogs', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs
Create a new Catalog.
User must have to provide the required fields in the POST request body for successful creation of a catalog.
The Response body should have to create a new catalog and return 201 Created.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CatalogModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Catalog created successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get the list of catalogs
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/catalogs', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs
Get the list of catalogs with date filters
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Additionally an operator can be provided with the date to select the records for the selected filters. We support following formats for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is explained in the paramter description.
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdated string |
query | Updated date to filter list. |
status array[string] |
query | Status of catalog |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdated: Updated date to filter list.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Our API supports a special format for date filters, allowing you to use different operators to obtain the desired results.
The following formats are supported for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is as follows:
eq (Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated on the specified date will be filtered.
Examples: eq(2024-02-05T00:00:00.000-0000), eq(2024-02-05T00:00:00.000) will filter all records updated on the specified date.
gt (Greater Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after the specified date will be filtered.
Examples: gt(2024-02-05T00:00:00.000-0000), gt(2024-02-05T00:00:00.000), gt(2024-02-05T00:00:00-0000), gt(2024-02-05T00:00:00), gt(2024-02-05) will filter all records updated after the specified date.
gte (Greater Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after and including the specified date will be filtered.
Examples: gte(2024-02-05T00:00:00.000-0000), gte(2024-02-05T00:00:00.000), gte(2024-02-05T00:00:00-0000), gte(2024-02-05T00:00:00), gte(2024-02-05) will filter all records updated after or on the specified date.
lt (Less Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before the specified date will be filtered.
Example: lt(2024-02-05T00:00:00.000-0000), lt(2024-02-05T00:00:00.000), lt(2024-02-05T00:00:00-0000), lt(2024-02-05T00:00:00), lt(2024-02-05) will filter all records updated before the specified date.
lte (Less Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before and including the specified date will be filtered.
Examples: lte(2024-02-05T00:00:00.000-0000), lte(2024-02-05T00:00:00.000), lte(2024-02-05T00:00:00-0000), lte(2024-02-05T00:00:00), lte(2024-02-05) will filter all records updated before or on the specified date.
btw (Between)
Description: Accepts two dates as parameters (both are required).
Behavior: When this operator is selected, all records updated between the specified start and end dates will be filtered.
Examples: btw(2024-02-05T00:00:00.000-0000, 2024-02-06T00:00:00.000-0000), btw(2024-02-05T00:00:00.000, 2024-02-06T00:00:00.000), btw(2024-02-05T00:00:00-0000, 2024-02-06T00:00:00-0000), btw(2024-02-05T00:00:00, 2024-02-06T00:00:00), btw(2024-02-05, 2024-02-06) will filter all records updated between the specified dates.
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| status | APPROVED |
| status | DISAPPROVED |
| status | NEW |
| status | PUBLISHED |
| status | REJECTED |
| status | UNPUBLISHED |
| status | UPDATED |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalogs list returned. |
CatalogListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Catalog by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/{id}
Get Catalog by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by externalId.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog successfully returned. |
CatalogModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Provided reference of catalog not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Catalog by ID
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/{id}
Update catalog by ID.
You can either provide system generated Id or user provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Update request will overwrite the existing data stored in the system. If the request does not contain the specific fields in the payload, those fields will be considered as null.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by externalId.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body CatalogModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog updated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Catalog id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Catalog by ID
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/catalogs/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/catalogs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/catalogs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /catalogs/{id}
Delete catalog by ID.
You can either provide system generated Id or user provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Delete request will remove the catalog existing data from system along with disassociating of suppliers with that specific catalog. If the request param do not have id or externalId then it will be consider an invalid request.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by externalId.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog deleted successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Catalog by Name
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/name/{name} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/name/{name}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/name/{name}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/name/{name}
Update catalog by catalog name.
Update request will overwrite the existing data stored in the system. If the request does not contain the specific fields in the payload, those fields will be considered as null.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by catalog name.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the catalog |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
body CatalogModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog updated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Catalog name not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Catalog By Name
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/name/{name} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/name/{name}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/name/{name}',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/name/{name}
Get Catalog by name
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by catalog name.
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the catalog |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog returned. |
CatalogModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Catalog by Name
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/catalogs/name/{name} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://api.vroozi.com/v1/catalogs/name/{name}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.vroozi.com/v1/catalogs/name/{name}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /catalogs/name/{name}
Delete catalog by Name.
Delete request will remove the catalog existing data from system along with disassociating of suppliers with that specific catalog. If the request param do not have catalog name then it will be consider invalid request.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when referencing catalog by catalog name.
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | Name of the catalog |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog. |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are uploading the item by catalog name. In such cases combination of catalog name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog deleted successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog Name not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Published Catalogs
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/published \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/published");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/published',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/published', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/published',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/published
Get published catalogs by date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of published catalogs. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalogs list returned. |
CatalogListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Catalog Status by ID
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/{id}/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"payload": {
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/{id}/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/{id}/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/{id}/status-update
This is an asynchronous request to perform the specified action. The catalog status will be updated as a result of this action.
You have to provide the required field values in the POST request.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it is required to send the request header useExternalId with value of true.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when updating status by externalId.
Body parameter
{
"payload": {
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog action performed successfully. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Catalog Status by Name
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/name/{name}/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"payload": {
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/name/{name}/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/name/{name}/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/name/{name}/status-update
This is an asynchronous request to perform the specified action. The catalog status will be updated as a result of this action.
You have to provide the required field values in the POST request.
There might exist multiple versions of the catalog, in such cases additional query parameter ‘version’ is required to uniquely identify the catalog when updating status by catalog name.
Body parameter
{
"payload": {
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by name. In such cases combination of name and version will uniquely identify the catalog. |
body |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by name. In such cases combination of name and version will uniquely identify the catalog.
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Catalog action performed successfully. |
AsyncResponseModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Unauthorized |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get progress status of async request by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/catalogs/async-requests/{trackingId} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/async-requests/{trackingId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/async-requests/{trackingId}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/catalogs/async-requests/{trackingId}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/catalogs/async-requests/{trackingId}',
params: {
}, headers: headers
p JSON.parse(result)
GET /catalogs/async-requests/{trackingId}
Progress status of async request by Tracking Id
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "status-update",
"requestMethod": "status-update",
"processingStatus": "IN_PROGRESS",
"metadata": {
"catalogId": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"catalogName": "Summer'18 Catalog",
"version": 2,
"active": true,
"states": {
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"totalItems": 505,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55
},
"catalogStatus": "PUBLISHED"
},
"newVersionMetadata": {
"catalogId": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"catalogName": "Summer'18 Catalog",
"version": 2,
"active": true,
"states": {
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"totalItems": 505,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55
},
"catalogStatus": "PUBLISHED"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"errorReportLink": "https://admin.vroozi.com/adminui/view-error-report?catId=65014b34778f4a6305233ea2",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
A representation of Async request’s progress status. |
AsyncRequestTrackingModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Async Request is not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Classes
List Classes
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/classes \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/classes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/classes',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/classes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/classes',
params: {
}, headers: headers
p JSON.parse(result)
GET /classes
Query all classes.
If the lastUpdatedAfter parameter is provided, then it will return the list of class updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of class. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Class list returned. |
ClassListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Class
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/classes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ignoreStatus: true'
URL obj = new URL("https://api.vroozi.com/v1/classes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'ignoreStatus':'true'
};
fetch('https://api.vroozi.com/v1/classes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'ignoreStatus': 'true'
}
r = requests.post('https://api.vroozi.com/v1/classes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'ignoreStatus' => 'true'
}
result = RestClient.post 'https://api.vroozi.com/v1/classes',
params: {
}, headers: headers
p JSON.parse(result)
POST /classes
Create a new class
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
ignoreStatus boolean |
header | If true active flag will be ignored and set it to true |
body ClassModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Class has been created. |
ClassModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Class or any reference object couldn’t be found. |
Inline |
409 |
Class contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Class
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/classes/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ignoreStatus: true'
URL obj = new URL("https://api.vroozi.com/v1/classes/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'ignoreStatus':'true'
};
fetch('https://api.vroozi.com/v1/classes/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'ignoreStatus': 'true'
}
r = requests.post('https://api.vroozi.com/v1/classes/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'ignoreStatus' => 'true'
}
result = RestClient.post 'https://api.vroozi.com/v1/classes/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /classes/upsert
Create/Update class
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
ignoreStatus boolean |
header | If true active flag will be ignored and set it to true for creation and ignored for update |
body ClassModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Class is updated successfully. |
ClassModel |
201 |
Class is created successfully. |
ClassModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Class or any reference object couldn’t be found. |
Inline |
409 |
Class contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Class
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/classes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/classes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/classes/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/classes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/classes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /classes/{id}
Get class by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Class object returned |
ClassModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Class or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Class
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/classes/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string' \
-H 'ignoreStatus: true'
URL obj = new URL("https://api.vroozi.com/v1/classes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string',
'ignoreStatus':'true'
};
fetch('https://api.vroozi.com/v1/classes/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string',
'ignoreStatus': 'true'
}
r = requests.put('https://api.vroozi.com/v1/classes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string',
'ignoreStatus' => 'true'
}
result = RestClient.put 'https://api.vroozi.com/v1/classes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /classes/{id}
Update class by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
ignoreStatus boolean |
header | If true active flag will be ignored |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body ClassModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Class has been updated. |
ClassModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Class or any reference object couldn’t be found. |
Inline |
409 |
Class contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Class
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/classes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/classes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/classes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/classes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/classes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /classes/{id}
Delete class by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Class object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Class id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or Update the Class in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/classes/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/classes/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/classes/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/classes/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/classes/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /classes/bulk-upsert/async
Create or Update the Class in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Class bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert Class by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/classes/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/classes/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/classes/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/classes/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/classes/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /classes/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert Class by Tracking ID
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/class/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "CLASS",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"channel": "CHA-1",
"description": "Class 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000",
"name": "Class-123.",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": null
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of async bulk upsert request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Company Codes
List Company Codes
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/company-codes \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/company-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/company-codes',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/company-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/company-codes',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-codes
Get the list of company codes
If the lastUpdatedAfter parameter is provided, then it will return the list of company codes updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of company codes. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Company codes list returned. |
CompanyCodeListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Company Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/company-codes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/company-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/company-codes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/company-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/company-codes',
params: {
}, headers: headers
p JSON.parse(result)
POST /company-codes
Create new company code
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CompanyCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Company Code is created successfully. |
CompanyCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company Code or any reference object couldn’t be found. |
Inline |
409 |
Company Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Company Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/company-codes/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/company-codes/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/company-codes/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/company-codes/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/company-codes/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /company-codes/upsert
Create/Update Company Code Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CompanyCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Company Code is updated successfully. |
CompanyCodeModel |
201 |
Company Code is created successfully. |
CompanyCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company Code or any reference object couldn’t be found. |
Inline |
409 |
Company Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Company Code
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/company-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/company-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/company-codes/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/company-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/company-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-codes/{id}
Get company code by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Company Code returned |
CompanyCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company Code or any reference object couldn’t be found. |
Inline |
409 |
Company Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Company Code
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/company-codes/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/company-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/company-codes/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/company-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/company-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /company-codes/{id}
Update company code by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true. Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
body CompanyCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Company Code is updated successfully. |
CompanyCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company Code or any reference object couldn’t be found. |
Inline |
409 |
Company Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Company Code
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/company-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/company-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/company-codes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/company-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/company-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /company-codes/{id}
Delete company code by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Company Code deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company Code or any reference object couldn’t be found. |
Inline |
409 |
Company Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Content Groups
Get the list of content groups
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/content-groups \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/content-groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/content-groups',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/content-groups', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/content-groups',
params: {
}, headers: headers
p JSON.parse(result)
GET /content-groups
Get list of content groups with filters.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Additionally an operator can be provided with the date to select the records for the selected filters. We support following formats for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is explained in the paramter description.
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdated string |
query | Updated date to filter list. |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdated: Updated date to filter list.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Our API supports a special format for date filters, allowing you to use different operators to obtain the desired results.
The following formats are supported for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is as follows
eq (Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated on the specified date will be filtered.
Examples: eq(2024-02-05T00:00:00.000-0000), eq(2024-02-05T00:00:00.000) will filter all records updated on the specified date.
gt (Greater Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after the specified date will be filtered.
Examples: gt(2024-02-05T00:00:00.000-0000), gt(2024-02-05T00:00:00.000), gt(2024-02-05T00:00:00-0000), gt(2024-02-05T00:00:00), gt(2024-02-05) will filter all records updated after the specified date.
gte (Greater Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after and including the specified date will be filtered.
Examples: gte(2024-02-05T00:00:00.000-0000), gte(2024-02-05T00:00:00.000), gte(2024-02-05T00:00:00-0000), gte(2024-02-05T00:00:00), gte(2024-02-05) will filter all records updated after or on the specified date.
lt (Less Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before the specified date will be filtered.
Example: lt(2024-02-05T00:00:00.000-0000), lt(2024-02-05T00:00:00.000), lt(2024-02-05T00:00:00-0000), lt(2024-02-05T00:00:00), lt(2024-02-05) will filter all records updated before the specified date.
lte (Less Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before and including the specified date will be filtered.
Examples: lte(2024-02-05T00:00:00.000-0000), lte(2024-02-05T00:00:00.000), lte(2024-02-05T00:00:00-0000), lte(2024-02-05T00:00:00), lte(2024-02-05) will filter all records updated before or on the specified date.
btw (Between)
Description: Accepts two dates as parameters (both are required).
Behavior: When this operator is selected, all records updated between the specified start and end dates will be filtered.
Examples: btw(2024-02-05T00:00:00.000-0000, 2024-02-06T00:00:00.000-0000), btw(2024-02-05T00:00:00.000, 2024-02-06T00:00:00.000), btw(2024-02-05T00:00:00-0000, 2024-02-06T00:00:00-0000), btw(2024-02-05T00:00:00, 2024-02-06T00:00:00), btw(2024-02-05, 2024-02-06) will filter all records updated between the specified dates.
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Groups list returned. |
ContentGroupModelList |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Content Group or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Content Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/content-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/content-groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/content-groups',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/content-groups', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/content-groups',
params: {
}, headers: headers
p JSON.parse(result)
POST /content-groups
Create a new Content Group.
User must have to provide the required fields in the POST request body for successful creation of a content Group.
The Response body should have to create a new content group and return 201 Created.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ContentGroupModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Content Group created successfully. |
ContentGroupModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content Group or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content Group contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Content Group By ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/content-groups/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-groups/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/content-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/content-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /content-groups/{id}
Get Content Group by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Group successfully returned. |
ContentGroupModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Provided reference of content group not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Content Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/content-groups/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-groups/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/content-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/content-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
POST /content-groups/{id}
Update content group by ID using merge update strategy of content view association.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body ContentGroupModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Group has been updated. |
ContentGroupModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content Group or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content Group contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Content Group
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/content-groups/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-groups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/content-groups/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/content-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /content-groups/{id}
Delete content group by ID.
You can either provide system generated Id or user provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If its value is true, id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case of useExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Group deleted successfully. |
ContentGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Content Group id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Content Group
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/content-groups/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'association-update-strategy: REPLACE'
URL obj = new URL("https://api.vroozi.com/v1/content-groups/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'association-update-strategy':'REPLACE'
};
fetch('https://api.vroozi.com/v1/content-groups/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'association-update-strategy': 'REPLACE'
}
r = requests.post('https://api.vroozi.com/v1/content-groups/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'association-update-strategy' => 'REPLACE'
}
result = RestClient.post 'https://api.vroozi.com/v1/content-groups/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /content-groups/upsert
Create/Update Content Group
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
association-update-strategy string |
header | Update strategy of content view association. |
body ContentGroupModelrequired |
body | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| association-update-strategy | REPLACE |
| association-update-strategy | MERGE |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Group updated successfully. |
ContentGroupModel |
201 |
Content Group created successfully. |
ContentGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content Group or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content Group contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Disassociate Content View(s) from the Content Group using Content Group ID
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/content-groups/{id}/content-views/disassociate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-groups/{id}/content-views/disassociate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-groups/{id}/content-views/disassociate',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/content-groups/{id}/content-views/disassociate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/content-groups/{id}/content-views/disassociate',
params: {
}, headers: headers
p JSON.parse(result)
PUT /content-groups/{id}/content-views/disassociate
Disassociate Content View(s) from the Content Group.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body ReferenceDataListModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Views association(s) removed successfully. |
ContentGroupModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Content View Associations
Associate Content Views to the Catalog using Catalog ID
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/{id}/content-views/associate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/content-views/associate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/content-views/associate',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/{id}/content-views/associate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/{id}/content-views/associate',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/{id}/content-views/associate
Associate new content views to the existing catalog.
Content views control the visibility of the catalog search and customer access to the catalogs.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it is required to send the request header useExternalId with value of true.
The response will return the list of content views provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all content views associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of content views. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content view(s) associated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Associate Content Views to the Catalog using Catalog Name
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/name/{name}/content-views/associate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/content-views/associate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/content-views/associate',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/name/{name}/content-views/associate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/name/{name}/content-views/associate',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/name/{name}/content-views/associate
Associate new content views to the existing catalog.
Content views control the visibility of the catalog search and customer access to the catalogs.
The response will return the list of content views provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all content views associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of content views. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content view(s) associated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Disassociate Content View(s) from the Catalog using Catalog ID
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/{id}/content-views/disassociate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/content-views/disassociate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/content-views/disassociate',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/{id}/content-views/disassociate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/{id}/content-views/disassociate',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/{id}/content-views/disassociate
Disassociate Content View(s) from the Catalog.
Content views control the visibility of the catalog search and customer access to the catalogs.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it is required to send the request header useExternalId with value of true.
The response will return the list of content views provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all content views associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of content views. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are updating by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content view association(s) removed successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Disassociate Content View from the Catalog using Catalog Name
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/name/{name}/content-views/disassociate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/content-views/disassociate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/content-views/disassociate',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/name/{name}/content-views/disassociate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/name/{name}/content-views/disassociate',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/name/{name}/content-views/disassociate
Disassociate Content View from the Catalog.
Content views control the visibility of the catalog search and customer access to the catalogs.
The response will return the list of content views provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all content views associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of content views. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content view association(s) removed successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Content Views
Get the list of Content Views
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/content-views \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/content-views");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/content-views',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/content-views', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/content-views',
params: {
}, headers: headers
p JSON.parse(result)
GET /content-views
Get list of catalog items by catalog name with filters.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Additionally an operator can be provided with the date to select the records for the selected filters. We support following formats for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is explained in the paramter description.
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdated string |
query | Updated date to filter list. |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdated: Updated date to filter list.
The dates should be in UTC Formats: yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ssZ, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd with and without time and time-zone offset.
Our API supports a special format for date filters, allowing you to use different operators to obtain the desired results.
The following formats are supported for date filters: eq, gt, gte, lt, lte, btw. Details of each operator is as follows
eq (Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated on the specified date will be filtered.
Examples: eq(2024-02-05T00:00:00.000-0000), eq(2024-02-05T00:00:00.000) will filter all records updated on the specified date.
gt (Greater Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after the specified date will be filtered.
Examples: gt(2024-02-05T00:00:00.000-0000), gt(2024-02-05T00:00:00.000), gt(2024-02-05T00:00:00-0000), gt(2024-02-05T00:00:00), gt(2024-02-05) will filter all records updated after the specified date.
gte (Greater Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated after and including the specified date will be filtered.
Examples: gte(2024-02-05T00:00:00.000-0000), gte(2024-02-05T00:00:00.000), gte(2024-02-05T00:00:00-0000), gte(2024-02-05T00:00:00), gte(2024-02-05) will filter all records updated after or on the specified date.
lt (Less Than)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before the specified date will be filtered.
Example: lt(2024-02-05T00:00:00.000-0000), lt(2024-02-05T00:00:00.000), lt(2024-02-05T00:00:00-0000), lt(2024-02-05T00:00:00), lt(2024-02-05) will filter all records updated before the specified date.
lte (Less Than or Equal To)
Description: Accepts a single date as a parameter.
Behavior: When this operator is selected, all records updated before and including the specified date will be filtered.
Examples: lte(2024-02-05T00:00:00.000-0000), lte(2024-02-05T00:00:00.000), lte(2024-02-05T00:00:00-0000), lte(2024-02-05T00:00:00), lte(2024-02-05) will filter all records updated before or on the specified date.
btw (Between)
Description: Accepts two dates as parameters (both are required).
Behavior: When this operator is selected, all records updated between the specified start and end dates will be filtered.
Examples: btw(2024-02-05T00:00:00.000-0000, 2024-02-06T00:00:00.000-0000), btw(2024-02-05T00:00:00.000, 2024-02-06T00:00:00.000), btw(2024-02-05T00:00:00-0000, 2024-02-06T00:00:00-0000), btw(2024-02-05T00:00:00, 2024-02-06T00:00:00), btw(2024-02-05, 2024-02-06) will filter all records updated between the specified dates.
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content Views list returned. |
ContentViewModelList |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Content View or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Content View
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/content-views \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/content-views");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/content-views',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/content-views', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/content-views',
params: {
}, headers: headers
p JSON.parse(result)
POST /content-views
Create a new Content View.
User must have to provide the required fields in the POST request body for successful creation of a content view.
The Response body should have to create a new catalog and return 201 Created.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ContentViewModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Content View created successfully. |
ContentViewModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content View or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content View contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Content View By ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/content-views/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-views/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-views/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/content-views/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/content-views/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /content-views/{id}
Get Content View by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | Id or externalId in case of useExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content View successfully returned. |
ContentViewModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Provided reference of Content View not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Content View
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/content-views/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-views/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-views/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/content-views/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/content-views/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /content-views/{id}
Update content View by ID using replace update strategy of content view association.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body ContentViewModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content View has been updated. |
ContentViewModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content View or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content View contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Content View
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/content-views/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/content-views/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/content-views/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/content-views/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/content-views/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /content-views/{id}
Delete Content View by ID.
You can either provide system generated Id or user provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If its value is true, id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case of useExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content View deleted successfully. |
ContentViewModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Content View id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Content View
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/content-views/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/content-views/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/content-views/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/content-views/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/content-views/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /content-views/upsert
Create/Update Content View
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ContentViewModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Content View updated successfully. |
ContentViewModel |
201 |
Content View created successfully. |
ContentViewModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorize it). |
GenericErrorModel |
404 |
Content View or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Content View contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Cost Centers
List Cost Centers
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/cost-centers \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/cost-centers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/cost-centers',
params: {
}, headers: headers
p JSON.parse(result)
GET /cost-centers
Query all cost centers.
If the lastUpdatedAfter parameter is provided, then it will return the list of cost centers updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of cost centers. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Cost Centers list returned. |
CostCenterListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Cost Center
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/cost-centers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/cost-centers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/cost-centers',
params: {
}, headers: headers
p JSON.parse(result)
POST /cost-centers
Create new cost center
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CostCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
CostCenter has been created. |
CostCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
CostCenter id not found. |
Inline |
409 |
Cost Center contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Cost Center
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/cost-centers/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/cost-centers/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/cost-centers/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /cost-centers/upsert
Create/Update cost center.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CostCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Cost Center is updated successfully. |
CostCenterModel |
201 |
Cost Center is created successfully. |
CostCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Cost Center or any reference object couldn’t be found. |
Inline |
409 |
Cost Center contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or update the Cost Centers in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/cost-centers/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/cost-centers/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/cost-centers/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /cost-centers/bulk-upsert/async
Create or update the Cost Centers in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Cost Centers bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Bulk Upsert Cost Centers Retry
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/cost-centers/bulk-upsert/async/retry?trackingId=string \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/bulk-upsert/async/retry?trackingId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers/bulk-upsert/async/retry?trackingId=string',
{
method: 'POST',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/cost-centers/bulk-upsert/async/retry', params={
'trackingId': 'string'
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/cost-centers/bulk-upsert/async/retry',
params: {
'trackingId' => 'string'
}, headers: headers
p JSON.parse(result)
POST /cost-centers/bulk-upsert/async/retry
This endpoint allows you to re-trigger the failed asynchronous bulk upsert request.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
query | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Cost Centers bulk upsert async request retry was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert Cost Center by Tracking Id
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/cost-centers/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/cost-centers/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/cost-centers/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/cost-centers/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /cost-centers/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert Cost Center by Tracking Id
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/cost-centers/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "COST_CENTER",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Cost Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"profitCenter": "PFT Center",
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "ERROR"
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of async bulk upsert request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Cost Center
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/cost-centers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/cost-centers/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/cost-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/cost-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /cost-centers/{id}
Get cost center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Cost Center returned |
CostCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
CostCenter id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Cost Center
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/cost-centers/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/cost-centers/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/cost-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/cost-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /cost-centers/{id}
Update cost center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body CostCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
CostCenter has been updated. |
CostCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
CostCenter id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Cost Center
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/cost-centers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/cost-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/cost-centers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/cost-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/cost-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /cost-centers/{id}
Delete cost center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Cost Center object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Cost Center term not found |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Custom Fields
Associate Custom Field(s) to the Catalog using Catalog ID
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/{id}/custom-fields/associate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/custom-fields/associate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/custom-fields/associate',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/{id}/custom-fields/associate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/{id}/custom-fields/associate',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/{id}/custom-fields/associate
Associate new custom fields to the existing catalog.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it is required to send the request header useExternalId with value of true.
The response will return the list of custom fields provided in the request payload. If there is a need to retrieve all custom fields associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of custom fields associated with the catalog. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing the catalog by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing the catalog by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Custom Field(s) associated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Associate Custom Field(s) to the Catalog using Catalog Name
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/associate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/associate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/associate',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/associate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/associate',
params: {
}, headers: headers
p JSON.parse(result)
POST /catalogs/name/{name}/custom-fields/associate
Associate new custom fields to the existing catalog.
The response will return the list of custom fields provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all custom fields associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of custom fields. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Custom field(s) associated successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Disassociate Custom Field(s) from the Catalog using Catalog ID
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/{id}/custom-fields/disassociate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/{id}/custom-fields/disassociate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/catalogs/{id}/custom-fields/disassociate',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/{id}/custom-fields/disassociate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/{id}/custom-fields/disassociate',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/{id}/custom-fields/disassociate
Disassociate Custom Field(s) from the Catalog.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it is required to send the request header useExternalId with value of true.
The response will return the list of custom fields provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all custom fields associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of custom fields. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing the catalog by externalId. In such cases combination of externalId and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing the catalog by externalId. In such cases combination of externalId and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Custom field association(s) removed successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Disassociate Custom Field(s) from the Catalog using Catalog Name
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/disassociate \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/disassociate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/disassociate',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/disassociate', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://api.vroozi.com/v1/catalogs/name/{name}/custom-fields/disassociate',
params: {
}, headers: headers
p JSON.parse(result)
PUT /catalogs/name/{name}/custom-fields/disassociate
Disassociate Custom Field(s) from the Catalog.
The response will return the list of custom fields provided in the request payload, any missing fields will be filled in the response. If there is a need to retrieve all custom fields associated with a catalog, use the other Catalog Get API to obtain the comprehensive list of custom fields. Please check the documentation for more details on the available Catalog APIs.
Body parameter
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
name stringrequired |
path | No description |
version integer |
query | Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog. |
body ReferenceDataListModelrequired |
body | No description |
Detailed descriptions
version: Version number of the catalog. This is an optional parameter. It becomes required when there are multiple versions of the catalog and we are referencing by catalog name. In such cases combination of name and version will uniquely identify the catalog.
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Custom field association(s) removed successfully. |
CatalogModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Catalog or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Customers
List Customers
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/customers \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/customers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/customers',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/customers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/customers',
params: {
}, headers: headers
p JSON.parse(result)
GET /customers
Query all customer objects.
If the lastUpdatedAfter parameter is provided, then it will return the list of customers updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of customers. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customers list returned. |
CustomerListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Customer
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/customers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/customers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/customers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/customers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/customers',
params: {
}, headers: headers
p JSON.parse(result)
POST /customers
Create a new Customer
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
body CustomerModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Customer is created successfully. |
CustomerModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer not found. |
ErrorDataModel |
409 |
Customer contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Customer
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/customers/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'association-update-strategy: REPLACE'
URL obj = new URL("https://api.vroozi.com/v1/customers/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'association-update-strategy':'REPLACE'
};
fetch('https://api.vroozi.com/v1/customers/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'association-update-strategy': 'REPLACE'
}
r = requests.post('https://api.vroozi.com/v1/customers/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'association-update-strategy' => 'REPLACE'
}
result = RestClient.post 'https://api.vroozi.com/v1/customers/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /customers/upsert
Update existing customer or create a new customer
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
association-update-strategy string |
header | Update strategy of customer accounting association. |
body CustomerModelrequired |
body | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| association-update-strategy | REPLACE |
| association-update-strategy | MERGE |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Customer is created successfully. |
CustomerModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer not found. |
ErrorDataModel |
409 |
Customer contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Customer
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/customers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/customers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/customers/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/customers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/customers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /customers/{id}
Get a customer by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer object returned |
CustomerModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Customer
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/customers/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/customers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/customers/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/customers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/customers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
POST /customers/{id}
Update customer by ID using merge update strategy of customer accounting association.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body CustomerModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer has been updated. |
CustomerModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer id not found. |
ErrorDataModel |
409 |
Customer contains duplicate externalId, code or name & company code. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Customer
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/customers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/customers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/customers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/customers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/customers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /customers/{id}
Delete customer by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer not found |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Customer Accounting Associations by Customer ID.
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/customers/{id}/associations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/customers/{id}/associations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/customers/{id}/associations',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/customers/{id}/associations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/customers/{id}/associations',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /customers/{id}/associations
Delete customer accounting association by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | Id or externalId in case that isExternalId is true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer accounting association has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer not found |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Customers by Code
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/customers/code/{code} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/customers/code/{code}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/customers/code/{code}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/customers/code/{code}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/customers/code/{code}',
params: {
}, headers: headers
p JSON.parse(result)
GET /customers/code/{code}
Get customers by code.
Parameters
| Parameter | In | Description |
|---|---|---|
code stringrequired |
path | Customer code |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer object returned |
CustomerModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Customer Accounting Associations by Customer Code.
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/customers/code/{code}/associations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/customers/code/{code}/associations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/customers/code/{code}/associations',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.delete('https://api.vroozi.com/v1/customers/code/{code}/associations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.vroozi.com/v1/customers/code/{code}/associations',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /customers/code/{code}/associations
Delete customer accounting associations by customer code.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
code stringrequired |
path | Customer code |
body |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Customer accounting association has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer not found |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
GL Accounts
List GL Accounts
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/gl-accounts \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/gl-accounts', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/gl-accounts',
params: {
}, headers: headers
p JSON.parse(result)
GET /gl-accounts
Query all gl accounts.
If the lastUpdatedAfter parameter is provided, then it will return the list of gl accounts updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of gl accounts. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GL accounts list returned. |
GLAccountListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create GL Account
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/gl-accounts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/gl-accounts', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/gl-accounts',
params: {
}, headers: headers
p JSON.parse(result)
POST /gl-accounts
Create a new GL Account
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GLAccountModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
GL Account is created successfully. |
GLAccountModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
GL Account or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert GL Account
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/gl-accounts/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/gl-accounts/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/gl-accounts/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /gl-accounts/upsert
Create/Update GL Account.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GLAccountModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GL Account is updated successfully. |
GLAccountModel |
201 |
GL Account is created successfully. |
GLAccountModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
GL Account or any reference object couldn’t be found. |
Inline |
409 |
GL Account contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or update the GL accounts in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /gl-accounts/bulk-upsert/async
Create or update the GL accounts in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The GL Account bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Bulk Upsert GL accounts Retry
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async/retry?trackingId=string \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async/retry?trackingId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async/retry?trackingId=string',
{
method: 'POST',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async/retry', params={
'trackingId': 'string'
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/gl-accounts/bulk-upsert/async/retry',
params: {
'trackingId' => 'string'
}, headers: headers
p JSON.parse(result)
POST /gl-accounts/bulk-upsert/async/retry
This endpoint allows you to re-trigger the failed asynchronous bulk upsert request.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
query | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The GL Account bulk upsert async request retry was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert GL Account by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/gl-accounts/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/gl-accounts/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/gl-accounts/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /gl-accounts/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert GL Account by Tracking ID
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/gl-accounts/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "GL_ACCOUNT",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"channel": "CHA-1",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "ERROR"
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of async bulk upsert request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get GL Account
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/gl-accounts/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/gl-accounts/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/gl-accounts/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/gl-accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /gl-accounts/{id}
Get gl account by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GL Account object returned |
GLAccountModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
GL Account or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update GL Account
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/gl-accounts/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/gl-accounts/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/gl-accounts/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/gl-accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /gl-accounts/{id}
Update GL Account by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body GLAccountModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GL Account has been updated. |
GLAccountModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
GL Account id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete GL Account
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/gl-accounts/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/gl-accounts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/gl-accounts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/gl-accounts/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/gl-accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /gl-accounts/{id}
Delete gl account by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GL Account object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
GL Account not found |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Goods Receipts
Get Goods Receipt by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-receipts/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/goods-receipts/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/goods-receipts/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-receipts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-receipts/{id}
Get Goods Receipt by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReceipt returned. |
GoodsReceiptModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReceipt or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipt By receiptNumber
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-receipts/receipt-number/{receiptNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/receipt-number/{receiptNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/receipt-number/{receiptNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/goods-receipts/receipt-number/{receiptNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-receipts/receipt-number/{receiptNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-receipts/receipt-number/{receiptNumber}
Get goods receipt by receiptNumber
Parameters
| Parameter | In | Description |
|---|---|---|
receiptNumber stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReceipt returned. |
GoodsReceiptModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReceipt or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipts
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-receipts/posted \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/posted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/posted',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/goods-receipts/posted', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-receipts/posted',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-receipts/posted
Get posted Goods Receipts by date.
If the postedAfter query parameters is provided, then it will return the list of goods receipts posted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posted goods receipts. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReceipt list returned. |
GoodsReceiptListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReceipt or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Post Goods Receipt
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-receipts/post \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/post");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/post',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-receipts/post', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-receipts/post',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-receipts/post
Post Goods Receipt
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GoodsReceiptModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Goods Receipt is created successfully. |
GoodsReceiptModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Goods Receipt or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods receipt contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Goods Receipt (Beta version)
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-receipts/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-receipts/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-receipts/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-receipts/upsert
Create/Update Goods Receipt. (This API is still under development and is only available for experimental purposes)
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GoodsReceiptModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt is updated successfully. |
GoodsReceiptModel |
201 |
Goods Receipt is created successfully. |
GoodsReceiptModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Goods Receipt or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods Receipt contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Post Goods Receipt Acknowledgement Status Update
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-receipts/acknowledgement-status \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/acknowledgement-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/acknowledgement-status',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-receipts/acknowledgement-status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-receipts/acknowledgement-status',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-receipts/acknowledgement-status
This endpoint can be used to send an acknowledgement status update along with externalId to notify the successful replication of Goods Receipt document posted in Vroozi application into client system
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AcknowledgementStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt acknowledgement updated successfully. |
AcknowledgementStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Goods Receipt or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods receipt contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Cancel Goods Receipt
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-receipts/cancel \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-receipts/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"externalId": "11001",
"docNo": "CC01",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"rmaNumber": "2736384",
"billOfLading": "bill",
"packingSlip": "packing",
"comments": "Cancelling a Goods Receipt 000001",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-receipts/cancel',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-receipts/cancel', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-receipts/cancel',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-receipts/cancel
Cancel Goods Receipt
This endpoint can be used to submit a Goods Receipt cancelation request. It can be used to cancel entire GR document as well as specific line. To cancel entire GR, goodsReceiptRef with either id, docNo or externalId should be provided, whereas to cancel line item from a given GR, goodsReceiptRef along to items to cancel should be provided.
Body parameter
{
"externalId": "11001",
"docNo": "CC01",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"rmaNumber": "2736384",
"billOfLading": "bill",
"packingSlip": "packing",
"comments": "Cancelling a Goods Receipt 000001",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ReceiptCancelModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt Canceled successfully. |
GoodsReturnModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Goods Receipt couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Goods Returns
Get Goods Return by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-returns/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/goods-returns/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/goods-returns/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-returns/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-returns/{id}
Get Goods Return by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReturn returned. |
GoodsReturnModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReturn or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Return By returnNumber
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-returns/return-number/{returnNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/return-number/{returnNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-returns/return-number/{returnNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/goods-returns/return-number/{returnNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-returns/return-number/{returnNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-returns/return-number/{returnNumber}
Get goods return by returnNumber
Parameters
| Parameter | In | Description |
|---|---|---|
returnNumber stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReturn returned. |
GoodsReturnModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReturn or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Return
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/goods-returns/posted \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/posted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-returns/posted',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/goods-returns/posted', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/goods-returns/posted',
params: {
}, headers: headers
p JSON.parse(result)
GET /goods-returns/posted
Get posted Goods Returns by date.
If the postedAfter query parameters is provided, then it will return the list of goods returns posted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posted goods receipts. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
GoodsReturn list returned. |
GoodsReturnListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
GoodsReturn or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Post Goods Return
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-returns/post \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/post");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-returns/post',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-returns/post', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-returns/post',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-returns/post
Post Goods Return Document to Vroozi.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GoodsReturnModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Return is updated successfully. |
GoodsReturnModel |
201 |
Goods Return is created successfully. |
GoodsReturnModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Goods Return or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods return contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Goods Return (Beta version)
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-returns/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-returns/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-returns/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-returns/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-returns/upsert
Upsert Goods Return Document in Vroozi. (This API is still under development and is only available for experimental purposes)
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body GoodsReturnModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Return is updated successfully. |
GoodsReturnModel |
201 |
Goods Return is created successfully. |
GoodsReturnModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Goods Return or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods return contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Post Goods Return Acknowledgement Status Update
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/goods-returns/acknowledgement-status \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/goods-returns/acknowledgement-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/goods-returns/acknowledgement-status',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/goods-returns/acknowledgement-status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/goods-returns/acknowledgement-status',
params: {
}, headers: headers
p JSON.parse(result)
POST /goods-returns/acknowledgement-status
This endpoint can be used to send an acknowledgement status update along with externalId to notify the successful replication of Goods Return document posted in Vroozi application into client system.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body AcknowledgementStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Return acknowledgement updated successfully. |
AcknowledgementStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden |
GenericErrorModel |
404 |
Goods Return or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Goods return contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Internal Orders
List Internal Orders
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/internal-orders \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/internal-orders',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/internal-orders', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/internal-orders',
params: {
}, headers: headers
p JSON.parse(result)
GET /internal-orders
Query all internal orders.
If the lastUpdatedAfter query parameters is provided, then it will return the list of internal orders updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of internal orders. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Internal orders list returned. |
InternalOrderListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Orders or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Internal Order
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/internal-orders \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/internal-orders',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/internal-orders', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/internal-orders',
params: {
}, headers: headers
p JSON.parse(result)
POST /internal-orders
Create a new internal order.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body InternalOrderModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Internal Order is created successfully. |
InternalOrderModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Order or any reference object couldn’t be found. |
Inline |
409 |
Internal Order contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Internal Order
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/internal-orders/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/internal-orders/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/internal-orders/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/internal-orders/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /internal-orders/upsert
Create/Update Internal Order
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body InternalOrderModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Internal Order is updated successfully. |
InternalOrderModel |
201 |
Internal Order is created successfully. |
InternalOrderModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Order or any reference object couldn’t be found. |
Inline |
409 |
Internal Order contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Internal Order
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/internal-orders/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/internal-orders/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/internal-orders/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/internal-orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /internal-orders/{id}
Get internal order by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, it’s required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Internal Order object returned |
InternalOrderModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Order or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Internal Order
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/internal-orders/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/internal-orders/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/internal-orders/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/internal-orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /internal-orders/{id}
Update internal order by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | ID value |
body InternalOrderModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Internal Order is updated successfully. |
InternalOrderModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Order or any reference object couldn’t be found. |
Inline |
409 |
Internal Order contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Internal Order
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/internal-orders/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/internal-orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/internal-orders/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/internal-orders/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/internal-orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /internal-orders/{id}
Delete internal order by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Internal Order object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Internal Order or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Invoices
Get Invoice by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/invoices/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/invoices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/invoices/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/invoices/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/invoices/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /invoices/{id}
Get Invoice by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice returned. |
InvoiceModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Invoice
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/invoices/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/invoices/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/invoices/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/invoices/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/invoices/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /invoices/{id}
Delete Invoice by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The Invoice, in any status, will be deleted if there is no payment and invoice is externally posted.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. Please see error message for more details. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Invoice By InvoiceNumber
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /invoices/invoice-number/{invoiceNumber}
Get invoice by invoice number
Parameters
| Parameter | In | Description |
|---|---|---|
invoiceNumber stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice returned. |
InvoiceModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Invoice By Invoice Number
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.vroozi.com/v1/invoices/invoice-number/{invoiceNumber}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /invoices/invoice-number/{invoiceNumber}
Delete Invoice by Invoice Number.
The Invoice, in any status, will be deleted if there is no payment and invoice is externally posted.
Parameters
| Parameter | In | Description |
|---|---|---|
invoiceNumber stringrequired |
path | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. Please see error message for more details. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Posting Invoices
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/invoices/status/posting \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/status/posting");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/status/posting',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/invoices/status/posting', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/invoices/status/posting',
params: {
}, headers: headers
p JSON.parse(result)
GET /invoices/status/posting
Get posting (ready to pay) invoices by date.
If the postingDateAfter query parameters is provided, then it will return the list of invoices posted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posting invoices. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice list returned. |
InvoiceListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Posted Invoices
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/invoices/posted \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/posted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/posted',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/invoices/posted', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/invoices/posted',
params: {
}, headers: headers
p JSON.parse(result)
GET /invoices/posted
Get posted invoices by date.
If the postingDateAfter query parameters is provided, then it will return the list of invoices posted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posted invoices. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice list returned. |
InvoiceListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Invoice summary by filter
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/invoices/status/search \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/status/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/status/search',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/invoices/status/search', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/invoices/status/search',
params: {
}, headers: headers
p JSON.parse(result)
GET /invoices/status/search
Get Invoice summary by given filter
Parameters
| Parameter | In | Description |
|---|---|---|
sortOrder string |
query | The direction of the results ordered by the sortField Example: ASC |
sortField string |
query | The name of the field to sort by |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page |
size integer |
query | Number of records to return per page. Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size |
Detailed descriptions
sortOrder: The direction of the results ordered by the sortField Example: ASC
sortField: The name of the field to sort by
page: Page number (per the size provided) of the returned results. Accepted values: page
size: Number of records to return per page.
Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size
Enumerated Values
| Parameter | Value |
|---|---|
| sortOrder | ASC |
| sortOrder | DESC |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.23,
"taxAmount": 20.43,
"shippingCharges": "10",
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 222.222,
"totalAmountWithUseTax": 333.033,
"invoiceNumber": "9000001616",
"status": "POSTED",
"invoiceDate": "2017-06-28T22:05:47.368+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice status returned. |
InvoiceStatusListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create/Update Invoice
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/invoices/post \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/post");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/post',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/invoices/post', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/invoices/post',
params: {
}, headers: headers
p JSON.parse(result)
POST /invoices/post
Create/update an invoice.
During the update if the invoice amount is updated than invoice status is recalculated based on the invoiced amount and payment amount. If the payment amount is greater or equal to invoiced amount, than the invoice is moved to PAID status. If the payment amount is less than the invoiced amount, than the invoice is moved to PARTIAL_PAYMENT status.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
body anyrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice has been updated. |
InvoiceModel |
201 |
Invoice has been created. |
InvoiceModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice id or any reference object could not be found. |
ErrorDataModel |
409 |
Invoice contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Invoice Status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/invoices/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/invoices/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/invoices/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /invoices/status-update
Send Invoice status update
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body InvoiceStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice summary has been updated. |
InvoiceStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Invoice id or any reference object could not be found. |
ErrorDataModel |
409 |
Invoice contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Invoice Status Bulk Update
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/invoices/bulk/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/bulk/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"statusUpdateModels": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/bulk/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/invoices/bulk/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/invoices/bulk/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /invoices/bulk/status-update
Invoice Status Bulk Update
Body parameter
{
"statusUpdateModels": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body |
body | No description |
Example responses
{
"success": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
],
"failed": [
{
"data": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
],
"totalSuccess": 1,
"totalFailed": 1
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoices have been updated to valid status. |
InvoiceBulkStatusUpdateResponseModel |
400 |
Bad request! Something went wrong. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid Action |
GenericErrorModel |
404 |
Invoice id or any reference object could not be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Accept incoming invoice for async processing
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/invoices/incoming/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/invoices/incoming/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/invoices/incoming/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/invoices/incoming/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/invoices/incoming/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /invoices/incoming/async
Accept incoming invoice for async processing.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
body anyrequired |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
Invoice incoming request is accepted. The request is under process. Use the request tracking API with the trackingId you received to track the progress. |
VrooziApiAsyncResponseModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
GenericErrorModel |
404 |
Invoice or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Location Types
List Location Types
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/location-types \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/location-types");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/location-types',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/location-types', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/location-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /location-types
Query all location types.
If the lastUpdatedAfter parameter is provided, then it will return the list of location types updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of location types. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location types list returned. |
LocationTypeListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Location Type
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/location-types \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/location-types");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/location-types',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/location-types', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/location-types',
params: {
}, headers: headers
p JSON.parse(result)
POST /location-types
Create a new Location Type
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body LocationTypeModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Location Type is created successfully. |
LocationTypeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
409 |
Location Type contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Location Type
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/location-types/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/location-types/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/location-types/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/location-types/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/location-types/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /location-types/upsert
Create/Update location type
Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body LocationTypeModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location Type is updated successfully. |
LocationTypeModel |
201 |
Location Type is created successfully. |
LocationTypeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
409 |
Location Type contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Location Type
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/location-types/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/location-types/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/location-types/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/location-types/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/location-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /location-types/{id}
Get location type by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location type object returned. |
LocationTypeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Location Type
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/location-types/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/location-types/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/location-types/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/location-types/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/location-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /location-types/{id}
Update location type by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body LocationTypeModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location Type has been updated. |
LocationTypeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
409 |
Location Type contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Location Type
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/location-types/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/location-types/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/location-types/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/location-types/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/location-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /location-types/{id}
Delete location type by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location Type has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Locations
List Locations
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/locations \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/locations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/locations',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/locations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/locations',
params: {
}, headers: headers
p JSON.parse(result)
GET /locations
Query all locations.
If the lastUpdatedAfter parameter is provided, then it will return the list of locations updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of locations. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Locations list returned. |
LocationListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Location
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/locations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/locations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/locations',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/locations', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/locations',
params: {
}, headers: headers
p JSON.parse(result)
POST /locations
Create a new location
Note: If any of the referenced company codes has a location types (locationTypeRequired) enabled than locationTypeRef will be required.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body LocationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Location is created successfully. |
LocationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location or any reference object couldn’t be found. |
Inline |
409 |
Location contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Location
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/locations/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/locations/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/locations/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/locations/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/locations/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /locations/upsert
Create/Update location
Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
If any of the referenced company codes has a location types (locationTypeRequired) enabled than locationTypeRef will be required.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body LocationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location is updated successfully. |
LocationModel |
201 |
Location is created successfully. |
LocationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location Type or any reference object couldn’t be found. |
Inline |
409 |
Location contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or Update the Locations in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/locations/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/locations/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/locations/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/locations/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/locations/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /locations/bulk-upsert/async
Create or Update the Locations in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Location bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert Locations by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/locations/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/locations/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/locations/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/locations/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/locations/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /locations/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert Locations by Tracking ID
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/locations/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "LOCATION",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"channel": "CHA-1",
"description": "Location LC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"name": "LC01",
"enableForAllCompanyCodes": false,
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": null
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of async bulk upsert request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Location
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/locations/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/locations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/locations/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/locations/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/locations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /locations/{id}
Get location by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location object returned. |
LocationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Location
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/locations/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/locations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/locations/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/locations/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/locations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /locations/{id}
Update location by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
If any of the referenced company codes has a location types (locationTypeRequired) enabled than locationTypeRef will be required.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body LocationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location has been updated. |
LocationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location or any reference object couldn’t be found. |
Inline |
409 |
Location contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Location
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/locations/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/locations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/locations/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/locations/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/locations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /locations/{id}
Delete location by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Location has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Location or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Memos
Get Memo by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.get('https://api.vroozi.com/v1/memos/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/{id}
Get Memo by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
negativeValueConversionStrategy string |
header | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo returned. |
MemoModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Memo By Document Number
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/document-number/{documentNumber} \
-H 'Accept: application/json' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/document-number/{documentNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/document-number/{documentNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.get('https://api.vroozi.com/v1/memos/document-number/{documentNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/document-number/{documentNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/document-number/{documentNumber}
Get memo by document number
When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting.
Parameters
| Parameter | In | Description |
|---|---|---|
documentNumber stringrequired |
path | No description |
negativeValueConversionStrategy string |
header | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo returned. |
MemoModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Posted Memos
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/posted \
-H 'Accept: application/json' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/posted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/posted',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.get('https://api.vroozi.com/v1/memos/posted', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/posted',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/posted
Get posted memos by date.
If the postingDateAfter query parameters is provided, then it will return the list of memos posted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posted memos. Max page size limit: 100
When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting.
Parameters
| Parameter | In | Description |
|---|---|---|
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
negativeValueConversionStrategy string |
header | No description |
Detailed descriptions
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo list returned. |
MemoListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Posting Memos
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/posting \
-H 'Accept: application/json' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/posting");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/posting',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.get('https://api.vroozi.com/v1/memos/posting', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/posting',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/posting
Get posting memos by date.
If the lastStatusChangeDateAfter query parameters is provided, then it will return the list of memos posting after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of posting memos. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastStatusChangeDateAfter string |
query | LastStatusChangeDateAfter date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500. When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting. |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
negativeValueConversionStrategy string |
header | No description |
Detailed descriptions
lastStatusChangeDateAfter: LastStatusChangeDateAfter date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500.
When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting.
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo list returned. |
MemoListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Approved Memos
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/approved \
-H 'Accept: application/json' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/approved");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/approved',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.get('https://api.vroozi.com/v1/memos/approved', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/approved',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/approved
Get approved memos by date.
If the lastStatusChangeDateAfter query parameters is provided, then it will return the list of memos approved after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of approved memos. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastStatusChangeDateAfter string |
query | LastStatusChangeDateAfter date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500. When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting. |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
negativeValueConversionStrategy string |
header | No description |
Detailed descriptions
lastStatusChangeDateAfter: LastStatusChangeDateAfter date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500.
When the negativeValueConversionStrategy parameter is set to AS_IS in GET API requests, the system will return the value of Total or any field contributing to the Total exactly as stored in the database, without applying any automatic conversions based on the negativeValuesForMemosEnabled setting.
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo list returned. |
MemoListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Memo summary by filter
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/memos/status/search \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/memos/status/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/memos/status/search',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/memos/status/search', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/memos/status/search',
params: {
}, headers: headers
p JSON.parse(result)
GET /memos/status/search
Get Memo summary by given filter
Parameters
| Parameter | In | Description |
|---|---|---|
sortOrder string |
query | The direction of the results ordered by the sortField Example: ASC |
sortField string |
query | The name of the field to sort by |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page |
size integer |
query | Number of records to return per page. Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size |
Detailed descriptions
sortOrder: The direction of the results ordered by the sortField Example: ASC
sortField: The name of the field to sort by
page: Page number (per the size provided) of the returned results. Accepted values: page
size: Number of records to return per page.
Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size
Enumerated Values
| Parameter | Value |
|---|---|
| sortOrder | ASC |
| sortOrder | DESC |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.87,
"taxAmount": 20.48,
"shippingCharges": 10.74,
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 2,
"totalAmountWithUseTax": 0.78,
"status": "POSTED",
"memoNumber": "9500000335",
"memoDate": "2018-03-15T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo summary returned. |
MemoStatusListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Memo Status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/memos/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/memos/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"comments": "Posting has failed"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/memos/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/memos/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/memos/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /memos/status-update
Send Memo status update
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"comments": "Posting has failed"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body MemoStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"comments": "Posting has failed"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo status has been updated. |
MemoStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo id or any reference object could not be found. |
ErrorDataModel |
409 |
Memo contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create/Update Memo
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/memos/post \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'negativeValueConversionStrategy: AS_IS'
URL obj = new URL("https://api.vroozi.com/v1/memos/post");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'negativeValueConversionStrategy':'AS_IS'
};
fetch('https://api.vroozi.com/v1/memos/post',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'negativeValueConversionStrategy': 'AS_IS'
}
r = requests.post('https://api.vroozi.com/v1/memos/post', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'negativeValueConversionStrategy' => 'AS_IS'
}
result = RestClient.post 'https://api.vroozi.com/v1/memos/post',
params: {
}, headers: headers
p JSON.parse(result)
POST /memos/post
Create/Update a Memo
When the negativeValueConversionStrategy parameter is set to AS_IS, the system will bypass the negativeValuesForMemosEnabled setting. This means the value provided in the request body for Total or any field contributing to the Total will be stored in the database exactly as submitted, including negative values, without any automatic conversion.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
Parameters
| Parameter | In | Description |
|---|---|---|
negativeValueConversionStrategy string |
header | No description |
body MemoModelrequired |
body | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| negativeValueConversionStrategy | AS_IS |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Memo has been updated. |
MemoModel |
201 |
Memo has been created. |
MemoModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Memo id or any reference object could not be found. |
ErrorDataModel |
409 |
Memo contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Ownership Transfer Requests
Get Ownership Transfer Requests
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/ownership-transfer-requests \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/ownership-transfer-requests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/ownership-transfer-requests',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/ownership-transfer-requests', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/ownership-transfer-requests',
params: {
}, headers: headers
p JSON.parse(result)
GET /ownership-transfer-requests
Get list of Ownership Transfer Requests by date, docType and statuses.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of ownership transfer requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
docType string |
query | Document Types for ownership changes |
status array[string] |
query | Status of ownership changes |
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| docType | PurchaseOrderModel |
| status | PENDING |
| status | ACKNOWLEDGED |
| status | EXECUTED |
| status | FAILED |
| status | PARTIALLY_EXECUTED |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Ownership Transfer Request list returned. |
OwnershipTransferRequestListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Ownership Transfer Request Details
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/ownership-transfer-requests/{id}/details \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/ownership-transfer-requests/{id}/details");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/ownership-transfer-requests/{id}/details',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/ownership-transfer-requests/{id}/details', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/ownership-transfer-requests/{id}/details',
params: {
}, headers: headers
p JSON.parse(result)
GET /ownership-transfer-requests/{id}/details
Get list of Ownership Transfer Request Details
The Metadata filed in response contains the ownership transfer request and content field contains the object details (Purchase Orders) with default page size 25. You can also provide the page and size to get the desired list of ownership transfers request details. Max page size limit: 100.
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | No description |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"metadata": {
"transferDetails": {
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
},
"content": [
[
{
"type": "PurchaseOrderModel"
}
]
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Ownership Transfer Request Details returned. |
OwnershipTransferRequestDetailModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Updates the Ownership Transfer Request status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/ownership-transfer-requests/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/ownership-transfer-requests/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "561234cdeacb256789aa",
"comments": "Ownership executed externally",
"status": "ACKNOWLEDGED",
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/ownership-transfer-requests/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/ownership-transfer-requests/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/ownership-transfer-requests/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /ownership-transfer-requests/status-update
Updates the Ownership Transfer Request status
POST API will only accept partial document updates for EXECUTED status. ACKNOWLEDGED/FAILED statuses do not support partial transfer of documents to new user. The response will contain the updateDetails array of documents sent in the request with EXECUTED status. If the transfer status is updated for all documents in the details the updateDetails array will be empty.
Body parameter
{
"id": "561234cdeacb256789aa",
"comments": "Ownership executed externally",
"status": "ACKNOWLEDGED",
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Ownership Transfer Requests status updated successfully. |
OwnershipTransferRequestModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Ownership Transfer Request couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Payment Requests
Get Payment Request by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payment-requests/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/payment-requests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/payment-requests/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/payment-requests/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/payment-requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payment-requests/{id}
Get Payment Request by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"name": "Pay Jan 20",
"reason": {
"description": "Reason"
},
"comments": "Process it immediately.",
"status": "POSTING",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"specialHandling": {
"required": false,
"option": "NO"
},
"shipTo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"paymentMethod": {
"type": "CHECK"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"documentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currencyCode": "USD",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"categoryRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
},
"currencyCode": "USD",
"unitOfMeasure": "EA",
"quantity": 2.4,
"unitPrice": 300.1,
"subTotal": 200.8,
"discountAmount": 10,
"shippingCharges": 2.3,
"taxAmount": 100.6,
"taxPercentage": 9.5,
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
]
}
],
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Request returned. |
PaymentRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Payment Request By documentNumber
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payment-requests/document-number/{documentNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-requests/document-number/{documentNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-requests/document-number/{documentNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/payment-requests/document-number/{documentNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/payment-requests/document-number/{documentNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payment-requests/document-number/{documentNumber}
Get payment request by documentNumber
Parameters
| Parameter | In | Description |
|---|---|---|
documentNumber stringrequired |
path | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"name": "Pay Jan 20",
"reason": {
"description": "Reason"
},
"comments": "Process it immediately.",
"status": "POSTING",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"specialHandling": {
"required": false,
"option": "NO"
},
"shipTo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"paymentMethod": {
"type": "CHECK"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"documentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currencyCode": "USD",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"categoryRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
},
"currencyCode": "USD",
"unitOfMeasure": "EA",
"quantity": 2.4,
"unitPrice": 300.1,
"subTotal": 200.8,
"discountAmount": 10,
"shippingCharges": 2.3,
"taxAmount": 100.6,
"taxPercentage": 9.5,
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
]
}
],
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
PaymentRequest returned. |
PaymentRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
PaymentRequest or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Payment Requests by Status
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payment-requests/status/{status} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-requests/status/{status}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-requests/status/{status}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/payment-requests/status/{status}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/payment-requests/status/{status}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payment-requests/status/{status}
Get Payment Requests by status and date
If the lastUpdatedAfter query parameters is provided, then it will return the list of payment requests after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of payment-requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
status stringrequired |
path | Payment request status |
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
status: Payment request status
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Enumerated Values
| Parameter | Value |
|---|---|
| status | approved |
| status | paid |
| status | partially_paid |
| status | pending_approval |
| status | posted |
| status | posting |
| status | posting_failed |
| status | rejected |
| status | canceled |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"name": "Pay Jan 20",
"reason": {
"description": "Reason"
},
"comments": "Process it immediately.",
"status": "POSTING",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"specialHandling": {
"required": false,
"option": "NO"
},
"shipTo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"paymentMethod": {
"type": "CHECK"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"documentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currencyCode": "USD",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"categoryRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
},
"currencyCode": "USD",
"unitOfMeasure": "EA",
"quantity": 2.4,
"unitPrice": 300.1,
"subTotal": 200.8,
"discountAmount": 10,
"shippingCharges": 2.3,
"taxAmount": 100.6,
"taxPercentage": 9.5,
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
]
}
],
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Request returned. |
PaymentRequestListModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Payment Request Status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/payment-requests/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-requests/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"comments": "Moving the document to POSTED",
"status": "POSTED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"errorType": "DATA_ERROR",
"autoPost": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-requests/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/payment-requests/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/payment-requests/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /payment-requests/status-update
Update the status of a Payment Request
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"comments": "Moving the document to POSTED",
"status": "POSTED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"errorType": "DATA_ERROR",
"autoPost": false
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PaymentRequestStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"comments": "Moving the document to POSTED",
"status": "POSTED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"errorType": "DATA_ERROR",
"autoPost": false
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Request status has been updated |
PaymentRequestStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment Request or any reference object could not be found. |
ErrorDataModel |
409 |
Payment Request contains duplicate externalId. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Payment Terms
List Payment Term
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payment-terms \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-terms',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/payment-terms', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/payment-terms',
params: {
}, headers: headers
p JSON.parse(result)
GET /payment-terms
Get the list of payment terms.
If the lastUpdatedAfter query parameters is provided, then it will return the list of payment terms updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of payment terms. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment terms list returned. |
PaymentTermListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Payment Term
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/payment-terms \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-terms',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/payment-terms', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/payment-terms',
params: {
}, headers: headers
p JSON.parse(result)
POST /payment-terms
Create new payment term.
You must supply the required field values in the POST request.
The response body will return the newly created payment term with generated ID.
Body parameter
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PaymentTermModelrequired |
body | No description |
Example responses
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Payment Term is created successfully. |
PaymentTermModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Payment Term
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/payment-terms/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payment-terms/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/payment-terms/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/payment-terms/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /payment-terms/upsert
Create/Update payment term Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PaymentTermModelrequired |
body | No description |
Example responses
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Term is updated successfully. |
PaymentTermModel |
201 |
Payment Term is created successfully. |
PaymentTermModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
409 |
Payment Term contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Payment Term
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payment-terms/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/payment-terms/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/payment-terms/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/payment-terms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payment-terms/{id}
Get payment term by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment term object returned. |
PaymentTermModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Payment Term
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/payment-terms/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/payment-terms/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/payment-terms/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/payment-terms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /payment-terms/{id}
Update payment term by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
You must supply the required field values in the PUT request for an update. The response body will include updated record. Any field that is not included in the update call will be updated with null values. Note: During an update request, only the fields provided in the payload will be updated.
Any field not included in the payload will retain its previous value. To reset a field’s value,
include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | ID value |
body PaymentTermModelrequired |
body | No description |
Example responses
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Term is updated successfully. |
PaymentTermModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Payment Term
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/payment-terms/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/payment-terms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/payment-terms/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/payment-terms/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/payment-terms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /payment-terms/{id}
Delete payment term by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The response will be 200 OK in case of successful deletion. You won’t be able to retrieve this data once deleted.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment Term object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Payment Term or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Payments
Create Payment
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/payments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payments',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/payments', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/payments',
params: {
}, headers: headers
p JSON.parse(result)
POST /payments
Create a new payment record
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PaymentModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Payment is created successfully. |
PaymentModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Payment by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payments/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/payments/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/payments/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/payments/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/payments/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payments/{id}
Get Payment by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment returned. |
PaymentModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Payment By PaymentNumber
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/payments/payment-number/{paymentNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payments/payment-number/{paymentNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payments/payment-number/{paymentNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/payments/payment-number/{paymentNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/payments/payment-number/{paymentNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /payments/payment-number/{paymentNumber}
Get payment by payment number
Parameters
| Parameter | In | Description |
|---|---|---|
paymentNumber stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment returned. |
PaymentModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Void Payment
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/payments/void \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/payments/void");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/payments/void',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://api.vroozi.com/v1/payments/void', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://api.vroozi.com/v1/payments/void',
params: {
}, headers: headers
p JSON.parse(result)
PUT /payments/void
Void an existing payment
Body parameter
{
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body VoidPaymentModelrequired |
body | No description |
Example responses
{
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Payment has been voided successfully. |
VoidPaymentModel |
400 |
Data validation failed. Please check your data and sent the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Payment or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Plant Codes
List Plant Codes
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/plant-codes \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/plant-codes',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/plant-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/plant-codes',
params: {
}, headers: headers
p JSON.parse(result)
GET /plant-codes
Get the list of plant codes
If the lastUpdatedAfter parameter is provided, then it will return the list of plant codes updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of plant codes. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Plant codes list returned. |
PlantCodeListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Plant Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/plant-codes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/plant-codes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/plant-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/plant-codes',
params: {
}, headers: headers
p JSON.parse(result)
POST /plant-codes
Create a new plant code.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PlantCodeModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Plant Code is created successfully. |
PlantCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
409 |
Plant Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Plant Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/plant-codes/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/plant-codes/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/plant-codes/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/plant-codes/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /plant-codes/upsert
Create/Update plant code Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PlantCodeModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Plant Code is updated successfully. |
PlantCodeModel |
201 |
Plant Code is created successfully. |
PlantCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Plant Code or any reference object couldn’t be found. |
Inline |
409 |
Plant Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Plant Code
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/plant-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/plant-codes/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/plant-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/plant-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /plant-codes/{id}
Get plant code by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Plant Code returned. |
PlantCodeModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Plant Code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Plant Code
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/plant-codes/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/plant-codes/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/plant-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/plant-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /plant-codes/{id}
Update plant code by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true. Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
body PlantCodeModelrequired |
body | No description |
Example responses
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Plant Code is updated successfully. |
PlantCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Plant Code or any reference object couldn’t be found. |
Inline |
409 |
Plant Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Plant Code
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/plant-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/plant-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/plant-codes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/plant-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/plant-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /plant-codes/{id}
Delete plant code by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Plant Code has been deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Plant Code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Profit Centers
List Profit Centers
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/profit-centers \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/profit-centers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/profit-centers',
params: {
}, headers: headers
p JSON.parse(result)
GET /profit-centers
Query all profit centers.
If the lastUpdatedAfter parameter is provided, then it will return the list of profit centers updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of profit centers. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Profit Centers list returned. |
ProfitCenterListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Profit Center
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/profit-centers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/profit-centers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/profit-centers',
params: {
}, headers: headers
p JSON.parse(result)
POST /profit-centers
Create a new profit center
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ProfitCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Profit Center has been created. |
ProfitCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
ProfitCenter id not found. |
Inline |
409 |
Profit Center contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Profit Center
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/profit-centers/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/profit-centers/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/profit-centers/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /profit-centers/upsert
Create/Update profit center
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ProfitCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Profit Center is updated successfully. |
ProfitCenterModel |
201 |
Profit Center is created successfully. |
ProfitCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Profit Center or any reference object couldn’t be found. |
Inline |
409 |
Profit Center contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Bulk Upsert Profit Centers Retry
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/profit-centers/bulk-upsert/async/retry?trackingId=string \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/bulk-upsert/async/retry?trackingId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers/bulk-upsert/async/retry?trackingId=string',
{
method: 'POST',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/profit-centers/bulk-upsert/async/retry', params={
'trackingId': 'string'
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/profit-centers/bulk-upsert/async/retry',
params: {
'trackingId' => 'string'
}, headers: headers
p JSON.parse(result)
POST /profit-centers/bulk-upsert/async/retry
This endpoint allows you to re-trigger the failed asynchronous bulk upsert request.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
query | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Profit Centers bulk upsert async request retry was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Profit Center
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/profit-centers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/profit-centers/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/profit-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/profit-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /profit-centers/{id}
Get profit center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Profit Center object returned. |
ProfitCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
ProfitCenter id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Profit Center
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/profit-centers/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/profit-centers/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/profit-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/profit-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /profit-centers/{id}
Update profit center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body ProfitCenterModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Profit Center has been updated. |
ProfitCenterModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
ProfitCenter id not found. |
Inline |
409 |
Profit Center contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Profit Center
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/profit-centers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/profit-centers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/profit-centers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/profit-centers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /profit-centers/{id}
Delete profit center by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Profit Center has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Profit Center not found |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or Update the Profit Centers in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/profit-centers/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/profit-centers/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/profit-centers/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /profit-centers/bulk-upsert/async
Create or Update the Profit Centers in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The Profit Centers bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert Profit Center by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/profit-centers/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/profit-centers/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/profit-centers/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/profit-centers/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/profit-centers/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /profit-centers/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert Profit Center by Tracking ID
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/profit-centers/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "PROFIT_CENTER",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"channel": "CHA-1",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"name": "PC11",
"validFrom": "2017-06-28",
"validTo": "2017-06-28"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": null
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of async bulk upsert request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Projects
List Projects
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/projects \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/projects',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/projects', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/projects',
params: {
}, headers: headers
p JSON.parse(result)
GET /projects
Query all projects.
If the lastUpdatedAfter parameter is provided, then it will return the list of projects updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of projects. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Projects list returned. |
ProjectListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Project
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/projects \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/projects',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/projects', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/projects',
params: {
}, headers: headers
p JSON.parse(result)
POST /projects
Create a new project
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ProjectModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Project has been created. |
ProjectModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
One of the referenced objects couldn’t be found. |
Inline |
409 |
Project contains duplicate externalId, code or name & company code. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Project
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/projects/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/projects/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/projects/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/projects/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/projects/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /projects/upsert
Create/Update project
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ProjectModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Project is updated successfully. |
ProjectModel |
201 |
Project is created successfully. |
ProjectModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Project or any reference object couldn’t be found. |
Inline |
409 |
Project contains duplicate externalId, code or name & company code. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Project
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/projects/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/projects/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/projects/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/projects/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/projects/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /projects/{id}
Get project by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Project object returned. |
ProjectModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Project id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Project
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/projects/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/projects/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/projects/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/projects/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/projects/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /projects/{id}
Update project by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body ProjectModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Project has been updated. |
ProjectModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Project id not found. |
Inline |
409 |
Project contains duplicate externalId, code or name & company code. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Project
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/projects/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/projects/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/projects/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/projects/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/projects/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /projects/{id}
Delete project by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Project has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Project id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Purchase Orders
Get Purchase Orders
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders
Get Purchase Orders by dates and statuses.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of issue purchase orders. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
status string |
query | Purchase Order allowed statuses to be used for filtering. If no status passed, then all POs matching these exposed statuses will be returned. Multiple statuses can be passed in comma separate format. Example: status=failed,invoiced,paid |
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
issueDateAfter string |
query | Last issue date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
includeCanceledItems boolean |
query | The includeCanceledItems query parameter is optional and the default value is false.. If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response. |
externallySynced boolean |
query | To fetch all Purchase Orders ready for external update, clients should set this flag to false in the query parameter. If the flag is set to true, it will retrieve Purchase Orders that have already been synced with the external system. After processing these documents, clients must update their status with externallySynced: true to prevent them from being included in future retrievals. |
Detailed descriptions
status: Purchase Order allowed statuses to be used for filtering.
If no status passed, then all POs matching these exposed statuses will be returned.
Multiple statuses can be passed in comma separate format.
Example: status=failed,invoiced,paid
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
issueDateAfter: Last issue date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
includeCanceledItems: The includeCanceledItems query parameter is optional and the default value is false..
If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response.
externallySynced: To fetch all Purchase Orders ready for external update, clients should set this flag to false in the query parameter. If the flag is set to true, it will retrieve Purchase Orders that have already been synced with the external system. After processing these documents, clients must update their status with externallySynced: true to prevent them from being included in future retrievals.
Enumerated Values
| Parameter | Value |
|---|---|
| status | canceled |
| status | cancellation_failed |
| status | confirmed |
| status | disputed |
| status | failed |
| status | invoiced |
| status | ordered |
| status | paid |
| status | partially_confirmed |
| status | partially_disputed |
| status | processing |
| status | received |
| status | shipped |
| status | submitted |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Order list returned. |
PurchaseOrderListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchase Order by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-orders/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/{id}
Get Purchase Order by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
includeCanceledItems boolean |
query | The includeCanceledItems query parameter is optional and the default value is false. If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response. |
Detailed descriptions
includeCanceledItems: The includeCanceledItems query parameter is optional and the default value is false.
If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response.
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Order returned. |
PurchaseOrderModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Purchase Order Status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-orders/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "ORDERED",
"comments": "Updating the Purchase Order Status",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-orders/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-orders/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-orders/status-update
Send status update for purchase order.
Body parameter
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "ORDERED",
"comments": "Updating the Purchase Order Status",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
body POStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "ORDERED",
"comments": "Updating the Purchase Order Status",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase order status is updated successfully. |
POStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Short Close Purchase Order
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-orders/short-close \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/short-close");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shortCloseFor": "RECEIVING"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/short-close',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-orders/short-close', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-orders/short-close',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-orders/short-close
Short close purchase order for receiving and/or invoicing.
Body parameter
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shortCloseFor": "RECEIVING"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body ShortCloseModelrequired |
body | No description |
Example responses
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shortCloseFor": "RECEIVING"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase order short closed successfully. |
ShortCloseModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchase Order By Order Number
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/order-number/{orderNumber}
Get purchase order by order number
Parameters
| Parameter | In | Description |
|---|---|---|
orderNumber stringrequired |
path | No description |
includeCanceledItems boolean |
query | The includeCanceledItems query parameter is optional and the default value is false. If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response. |
Detailed descriptions
includeCanceledItems: The includeCanceledItems query parameter is optional and the default value is false.
If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response.
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Order returned. |
PurchaseOrderModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
PurchaseOrder or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Submit Purchase Order document to Vroozi
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-orders/submit \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/submit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/submit',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-orders/submit', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-orders/submit',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-orders/submit
Submit Purchase Order document to Vroozi.
This API can be used to send purchase order document into Vroozi. To create a new purchase order document in Vroozi, you must provide at least one line item in the API request. When a purchase order already exists in Vroozi, the API can be used to update the existing purchase order. When updating the purchase order, if the previously sent line items are not provided, those line item will be marked as Canceled. If no line item is provided in the update request, the entire Purchase Order will be marked as Canceled. We can use item status or header status to cancel item or purchase order.
The notify-supplier query parameter is optional and the default value is false. If you want to submit the purchase order document to supplier, notify-supplier parameter should be passed with value as true.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
notify-supplier boolean |
query | The notify-supplier query parameter is optional and the default value is false |
grIndicator string |
query | The grIndicator query parameter is optional and the default value is SYSTEM_LEVEL. If you want to use line items to decide goods receipt creation, grIndicator parameter should be passed with value as LINE_LEVEL. If you want to use the PO header level, grIndicator parameter should be passed with value as HEADER_LEVEL. If you want the use the system level goods receipt settings, grIndicator parameter should be passed with value as SYSTEM_LEVEL. |
includeCanceledItems boolean |
query | The includeCanceledItems query parameter is optional and the default value is false.. If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response. |
validate-workflow boolean |
query | The validate-workflow query parameter is optional and the default value is false. When validate-workflow is true, only APPROVED PR/CR can be referenced in the PO. PR/CR is auto approved and can be referenced from SUBMITTED status if the validate-workflow is false. |
body PurchaseOrderModelrequired |
body | No description |
Detailed descriptions
grIndicator: The grIndicator query parameter is optional and the default value is SYSTEM_LEVEL.
If you want to use line items to decide goods receipt creation, grIndicator parameter should be passed with value as LINE_LEVEL. If you want to use the PO header level, grIndicator parameter should be passed with value as HEADER_LEVEL. If you want the use the system level goods receipt settings, grIndicator parameter should be passed with value as SYSTEM_LEVEL.
includeCanceledItems: The includeCanceledItems query parameter is optional and the default value is false..
If you want to receive list of canceled items in response, pass includeCanceledItems with value true. If this flag is false then the canceled items will not be populated with data in the response.
validate-workflow: The validate-workflow query parameter is optional and the default value is false.
When validate-workflow is true, only APPROVED PR/CR can be referenced in the PO. PR/CR is auto approved and can be referenced from SUBMITTED status if the validate-workflow is false.
Enumerated Values
| Parameter | Value |
|---|---|
| grIndicator | LINE_LEVEL |
| grIndicator | HEADER_LEVEL |
| grIndicator | SYSTEM_LEVEL |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase order is updated successfully. |
PurchaseOrderModel |
201 |
Purchase order is created successfully. |
PurchaseOrderModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Invoices by status for a given Purchase Order By ID.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/{id}/invoices \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/{id}/invoices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-orders/{id}/invoices',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/{id}/invoices', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/{id}/invoices',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/{id}/invoices
Get Invoices by Status and Purchase Order
You can either provide Purchase Order system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
status string |
query | Status of the invoices. Comma separated values are allowed. |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Enumerated Values
| Parameter | Value |
|---|---|
| status | POSTED |
| status | POSTING_FAILED |
| status | PAID |
| status | PARTIAL_PAYMENT |
| status | POSTING |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice list returned. |
InvoiceListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Invoices by status for a given Purchase Order By Order Number.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/invoices \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/invoices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/invoices',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/invoices', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/invoices',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/order-number/{orderNumber}/invoices
Get Invoices by status for a given Purchase Order By Order Number.
Parameters
| Parameter | In | Description |
|---|---|---|
orderNumber stringrequired |
path | No description |
status string |
query | Status of the invoices. Comma separated values are allowed. |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Enumerated Values
| Parameter | Value |
|---|---|
| status | POSTED |
| status | POSTING_FAILED |
| status | PAID |
| status | PARTIAL_PAYMENT |
| status | POSTING |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Invoice list returned. |
InvoiceListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipts by status for a given Purchase Order By ID.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/{id}/goods-receipts
Get Goods Receipts by Status and Purchase Order
You can either provide Purchase Order system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt list returned. |
GoodsReceiptListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipts by status for a given Purchase Order By Order Number.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/order-number/{orderNumber}/goods-receipts
Get Goods Receipts by status for a given Purchase Order By Order Number.
Parameters
| Parameter | In | Description |
|---|---|---|
orderNumber stringrequired |
path | No description |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt list returned. |
GoodsReceiptListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Returns by status for a given Purchase Order By ID.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/{id}/goods-returns \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/{id}/goods-returns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-orders/{id}/goods-returns',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/{id}/goods-returns', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/{id}/goods-returns',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/{id}/goods-returns
Get Goods Returns by Status and Purchase Order
You can either provide Purchase Order system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Return list returned. |
GoodsReturnListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Returns by status for a given Purchase Order By Order Number.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-returns \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-returns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-returns',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-returns', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-returns',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/order-number/{orderNumber}/goods-returns
Get Goods Returns by status for a given Purchase Order By Order Number.
Parameters
| Parameter | In | Description |
|---|---|---|
orderNumber stringrequired |
path | No description |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
postingDateAfter string |
query | Posting after date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
Detailed descriptions
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
postingDateAfter: Posting after date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Return list returned. |
GoodsReturnListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipts and Returns by status for a given Purchase Order By ID.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts-returns \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts-returns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts-returns',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts-returns', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/{id}/goods-receipts-returns',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/{id}/goods-receipts-returns
Get Goods Receipts and Returns by Status and Purchase Order
You can either provide Purchase Order system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"goodsRceipts": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
],
"goodsReturns": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Goods Receipt and Returns returned. |
POGoodsReceiptReturnModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Goods Receipts and Returns by status for a given Purchase Order By Order Number.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts-returns \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts-returns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts-returns',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts-returns', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-orders/order-number/{orderNumber}/goods-receipts-returns',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-orders/order-number/{orderNumber}/goods-receipts-returns
Get Goods Receipts and Returns by status for a given Purchase Order By Order Number.
Parameters
| Parameter | In | Description |
|---|---|---|
orderNumber stringrequired |
path | No description |
Example responses
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"goodsRceipts": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
],
"goodsReturns": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Order Goods Receipts and Returns returned. |
POGoodsReceiptReturnModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Order or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update the Purchase Order externallySynced flag
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-orders/sync-status \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-orders/sync-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"externallySynced": true,
"purchaseOrderRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-orders/sync-status',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-orders/sync-status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-orders/sync-status',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-orders/sync-status
Update the Purchase Order externallySynced flag
Body parameter
{
"externallySynced": true,
"purchaseOrderRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
}
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body POStatusSyncModelrequired |
body | No description |
Example responses
{
"externallySynced": true,
"purchaseOrderRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase orders successfully synced with the external system. |
POStatusSyncModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Purchase Order id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Purchase Requests
Create Purchase Request
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-requests \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-requests', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-requests',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-requests
Create new purchase request.
You must supply the required field values in the POST request.
The response body will return the newly created purchase request with generated ID.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PurchaseRequestModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Purchase Request is created successfully. |
PurchaseRequestModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Purchase Request Status
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-requests/status-update \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/status-update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "APPROVED",
"comments": "Updating the Purchase Request Status"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/status-update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-requests/status-update', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-requests/status-update',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-requests/status-update
Send status update for purchase request.
Body parameter
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "APPROVED",
"comments": "Updating the Purchase Request Status"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PRStatusUpdateModelrequired |
body | No description |
Example responses
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "APPROVED",
"comments": "Updating the Purchase Request Status"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request status is updated successfully. |
PRStatusUpdateModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Submit Purchase Request by ID
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-requests/{id}/submit \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/{id}/submit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"approverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"souringReviewerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-requests/{id}/submit',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/purchase-requests/{id}/submit', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-requests/{id}/submit',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-requests/{id}/submit
Submit purchase request by ID for approval
You can either provide system generated ID or your provided externalId.
To use your provided externalId, specific the header value useExternalId with value of true.
Use this API to submit Purchase Request (PR) for approval in PMan application. If the buy route is enabled and the purchase request is auto-approved, the PR line items will be send to buyer, otherwise the Purchase Order (PO) will be generated and submitted to supplier based on configured supplier output method.
When a purchase request has only one eligible sourcing approver, the system automatically selects that sourcing approver. If multiple sourcing approvers are eligible to review or approve the purchase request, the user must select a valid sourcing reviewer or approver from the list generated by the system based on sourcing rules.
Body parameter
{
"approverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"souringReviewerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
body |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request submitted returned. |
PurchaseRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
412 |
Purchase Request’s Precondition failed. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Submit Purchase Request by RequestNumber
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}/submit \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}/submit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"approverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"souringReviewerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}/submit',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}/submit', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}/submit',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchase-requests/request-number/{requestNumber}/submit
Submit purchase request by RequestNumber for approval
Use this API to submit Purchase Request (PR) for approval in PMan application. If the buy route is enabled and the purchase request is auto-approved, the PR line items will be send to buyer, otherwise the Purchase Order (PO) will be generated and submitted to supplier based on configured supplier output method.
When a purchase request has only one eligible sourcing approver, the system automatically selects that sourcing approver. If multiple sourcing approvers are eligible to review or approve the purchase request, the user must select a valid sourcing reviewer or approver from the list generated by the system based on sourcing rules.
Body parameter
{
"approverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"souringReviewerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Parameters
| Parameter | In | Description |
|---|---|---|
requestNumber stringrequired |
path | No description |
body |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request submitted returned. |
PurchaseRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
PurchaseRequest or any reference object couldn’t be found. |
ErrorDataModel |
412 |
Purchase Request’s Precondition failed. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get pending purchase requests by date.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/pending \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/pending");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/pending',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/pending', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/pending',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/pending
Get pending purchase request by date.
If the submittedDateAfter query parameters is provided, then it will return the list of pending purchase requests submitted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of pending purchase requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
submittedDateAfter string |
query | Last submitted date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
submittedDateAfter: Last submitted date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request list returned. |
PurchaseRequestListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get submitted purchase requests by date.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/submitted \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/submitted");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/submitted',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/submitted', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/submitted',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/submitted
Get submitted purchase request by date.
If the submittedDateAfter query parameters is provided, then it will return the list of submitted purchase requests submitted after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of submitted purchase requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
submittedDateAfter string |
query | Last submitted date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
submittedDateAfter: Last submitted date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request list returned. |
PurchaseRequestListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get approved purchase requests by date.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/approved \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/approved");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/approved',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/approved', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/approved',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/approved
Get approved purchase request by date.
If the approvedDateAfter query parameters is provided, then it will return the list of approved purchase requests approved after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of approved purchase requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
approvedDateAfter string |
query | Last approved date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
approvedDateAfter: Last approved date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request list returned. |
PurchaseRequestListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get rejected purchase requests by date.
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/rejected \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/rejected");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/rejected',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/rejected', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/rejected',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/rejected
Get rejected purchase request by date.
If the rejectedDateAfter query parameters is provided, then it will return the list of rejected purchase requests rejected after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of rejected purchase requests. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
rejectedDateAfter string |
query | Last rejected date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. |
Detailed descriptions
rejectedDateAfter: Last rejected date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page.
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request list returned. |
PurchaseRequestListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchase Request by ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-requests/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/{id}
Get Purchase Request by ID
You can either provide system generated ID or your provided externalId.
To use your provided externalId, specific the header value useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request returned. |
PurchaseRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Purchase Request
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/purchase-requests/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-requests/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/purchase-requests/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/purchase-requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /purchase-requests/{id}
Delete purchase request by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The purchase request, in any status, will be deleted if it is not referenced in any purchase order document.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Purchase Request
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/purchase-requests/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchase-requests/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/purchase-requests/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/purchase-requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /purchase-requests/{id}
Update Purchase Request by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | No description |
id stringrequired |
path | No description |
body PurchaseRequestModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request is updated successfully. |
PurchaseRequestModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchase Request By Request Number
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/request-number/{requestNumber}
Get purchase Request by request number
Parameters
| Parameter | In | Description |
|---|---|---|
requestNumber stringrequired |
path | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request returned. |
PurchaseRequestModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
PurchaseRequest or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Purchase Request By Request Number.
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber} \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.delete('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.delete 'https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /purchase-requests/request-number/{requestNumber}
Delete purchase request by requestNumber.
The purchase request, in any status, will be deleted if it is not referenced in any purchase order document.
Parameters
| Parameter | In | Description |
|---|---|---|
requestNumber stringrequired |
path | No description |
Example responses
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request deleted. |
None |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Purchase Request By Request Number
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.put('https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.put 'https://api.vroozi.com/v1/purchase-requests/request-number/{requestNumber}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /purchase-requests/request-number/{requestNumber}
Update Purchase Request by request number.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
requestNumber stringrequired |
path | No description |
body PurchaseRequestModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request is updated successfully. |
PurchaseRequestModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchase Request summary by filter
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchase-requests/status/search \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchase-requests/status/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchase-requests/status/search',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchase-requests/status/search', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchase-requests/status/search',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchase-requests/status/search
Get Purchase Request summary by given filter
Parameters
| Parameter | In | Description |
|---|---|---|
sortOrder string |
query | The direction of the results ordered by the sortField Example: ASC |
sortField string |
query | The name of the field to sort by |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page |
size integer |
query | Number of records to return per page. Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size |
Detailed descriptions
sortOrder: The direction of the results ordered by the sortField Example: ASC
sortField: The name of the field to sort by
page: Page number (per the size provided) of the returned results. Accepted values: page
size: Number of records to return per page.
Default value is 100, and maximum 10000 records can be requested per page. Accepted values: size
Enumerated Values
| Parameter | Value |
|---|---|
| sortOrder | ASC |
| sortOrder | DESC |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.55,
"taxAmount": 20.56,
"shippingCharges": 10.12,
"totalAmount": 2002.43,
"itemsCount": 2,
"requestNumber": "2000002699",
"name": "2000002699",
"status": "REJECTED",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchase Request summary returned. |
PurchaseRequestStatusListModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchase Request or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Purchasing Organizations
List Purchasing Organizations
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchasing-orgs \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/purchasing-orgs', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchasing-orgs',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchasing-orgs
Query all purchasing organizations.
If the lastUpdatedAfter parameter is provided, then it will return the list of purchasing organization updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of purchasing organization. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchasing Organizations list returned. |
PurchasingOrganizationListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create Purchasing Organization
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchasing-orgs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchasing-orgs', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchasing-orgs',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchasing-orgs
Create a new Purchasing Organization
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PurchasingOrganizationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Purchasing Organization has been created. |
PurchasingOrganizationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchasing Organization id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Purchasing Organization
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/purchasing-orgs/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/purchasing-orgs/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/purchasing-orgs/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /purchasing-orgs/upsert
Create/Update Purchasing Organization
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body PurchasingOrganizationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchasing Organization is updated successfully. |
PurchasingOrganizationModel |
201 |
Purchasing Organization is created successfully. |
PurchasingOrganizationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchasing Organization or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Purchasing Organization contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Purchasing Organization
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/purchasing-orgs/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/purchasing-orgs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/purchasing-orgs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /purchasing-orgs/{id}
Get Purchasing Organization by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchasing Organization returned |
PurchasingOrganizationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchasing Organization id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Purchasing Organization
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/purchasing-orgs/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/purchasing-orgs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/purchasing-orgs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /purchasing-orgs/{id}
Update Purchasing Organization by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body PurchasingOrganizationModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchasing Organization has been updated. |
PurchasingOrganizationModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchasing Organization id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Purchasing Organization
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/purchasing-orgs/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/purchasing-orgs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/purchasing-orgs/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/purchasing-orgs/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/purchasing-orgs/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /purchasing-orgs/{id}
Delete Purchasing Organization by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Purchasing Organization object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Purchasing Organization not found |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Suppliers
List Suppliers
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/suppliers \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/suppliers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/suppliers',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/suppliers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/suppliers',
params: {
}, headers: headers
p JSON.parse(result)
GET /suppliers
Get the list of suppliers
If the lastUpdatedAfter parameter is provided, then it will return the list of suppliers updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of suppliers. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Suppliers list returned. |
SupplierListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
None |
Create Supplier
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/suppliers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/suppliers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/suppliers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/suppliers', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/suppliers',
params: {
}, headers: headers
p JSON.parse(result)
POST /suppliers
Create new supplier
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body SupplierModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
Supplier has been created. |
SupplierModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Supplier id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Supplier
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/suppliers/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/suppliers/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/suppliers/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/suppliers/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/suppliers/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /suppliers/upsert
Create/Update supplier During the update process, if a field is omitted from the payload, its current stored value will be retained. To modify a field’s value, including resetting it to null, you must explicitly include it in the payload.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
body SupplierModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Supplier is updated successfully. |
SupplierModel |
201 |
Supplier is created successfully. |
SupplierModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Supplier or any reference object couldn’t be found. |
ErrorDataModel |
409 |
Supplier contains duplicate information. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get Supplier
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/suppliers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/suppliers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/suppliers/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/suppliers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/suppliers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /suppliers/{id}
Get supplier by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Supplier object returned. |
SupplierModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Supplier id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Supplier
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/suppliers/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/suppliers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/suppliers/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/suppliers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/suppliers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /suppliers/{id}
Update supplier by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Body parameter
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body SupplierModelrequired |
body | No description |
Example responses
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Supplier has been updated. |
SupplierModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Supplier or reference object not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Supplier
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/suppliers/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/suppliers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/suppliers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/suppliers/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/suppliers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /suppliers/{id}
Delete Supplier by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Supplier object has been deleted |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Supplier id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Tax Codes
List Tax Codes
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/tax-codes \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/tax-codes',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/tax-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/tax-codes',
params: {
}, headers: headers
p JSON.parse(result)
GET /tax-codes
Query all tax codes.
If the lastUpdatedAfter parameter is provided, then it will return the list of tax codes updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of tax codes. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Tax codes list returned. |
TaxCodeListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create Tax Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/tax-codes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/tax-codes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/tax-codes', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/tax-codes',
params: {
}, headers: headers
p JSON.parse(result)
POST /tax-codes
Create a new tax code
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body TaxCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
TaxCode has been created. |
TaxCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
TaxCode id not found. |
Inline |
409 |
Tax Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert Tax Code
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/tax-codes/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/tax-codes/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/tax-codes/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/tax-codes/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /tax-codes/upsert
Create/Update Tax Code.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body TaxCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Tax Code is updated successfully. |
TaxCodeModel |
201 |
Tax Code is created successfully. |
TaxCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tax Code or any reference object couldn’t be found. |
Inline |
409 |
Tax Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get Tax Code
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/tax-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/tax-codes/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/tax-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/tax-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /tax-codes/{id}
Get tax code by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Tax Code returned. |
TaxCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
ErrorDataModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
TaxCode id not found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update Tax Code
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/tax-codes/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/tax-codes/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/tax-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/tax-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /tax-codes/{id}
Update tax code by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body TaxCodeModelrequired |
body | No description |
Example responses
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Tax Code has been updated. |
TaxCodeModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tax Code id not found. |
Inline |
409 |
Tax Code contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete Tax Code
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/tax-codes/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/tax-codes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/tax-codes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/tax-codes/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/tax-codes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /tax-codes/{id}
Delete tax code by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Tax code has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tax code not found |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Users
List Users
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/users \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/users',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/users', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/users',
params: {
}, headers: headers
p JSON.parse(result)
GET /users
Get the list of users
If the lastUpdatedAfter parameter is provided, then it will return the list of users updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of users. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Users list returned. |
UserListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Create User
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/users \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/users',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/users', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/users',
params: {
}, headers: headers
p JSON.parse(result)
POST /users
Create a new user. The access-type query parameter is optional and the default value is SSO_LOGIN. If you want to send Registration email to the created user, access-type parameter should be passed with value as VROOZI_LOGIN
Body parameter
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
access-type string |
query | The access-type query parameter is optional and the default value is SSO_LOGIN |
body UserModelrequired |
body | No description |
Example responses
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
User has been created. |
UserModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action.’ |
GenericErrorModel |
404 |
User id or any reference object could not be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert User
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/users/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/users/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/users/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/users/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/users/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /users/upsert
Create/Update user. The access-type query parameter is optional and the default value is SSO_LOGIN. If you want to send Registration email to the created user, access-type parameter should be passed with value as VROOZI_LOGIN
Body parameter
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
access-type string |
query | The access-type query parameter is optional and the default value is SSO_LOGIN |
body UserModelrequired |
body | No description |
Example responses
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
User has been updated. |
UserModel |
201 |
User has been created. |
UserModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id or any reference object could not be found. |
ErrorDataModel |
409 |
User contains duplicate externalId or username. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Get User
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/users/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/users/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /users/{id}
Get User by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
Example responses
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
User object returned. |
UserModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update User
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/users/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/users/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /users/{id}
Update User by ID
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
You must supply the required field values in the PUT request for an update. The response body will include updated record. Any field that is not included in the update call will be updated with null values.
Body parameter
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body UserModelrequired |
body | No description |
Example responses
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
User has been updated. |
UserModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id or any reference object could not be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete User
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/users/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/users/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /users/{id}
Delete user by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
The response will be 200 OK in case of successful deletion. You won’t be able to retrieve this data once deleted.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that useExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
User object has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
List Account Access for a user
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/users/{id}/account-access-list \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}/account-access-list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}/account-access-list',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/users/{id}/account-access-list', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/users/{id}/account-access-list',
params: {
}, headers: headers
p JSON.parse(result)
GET /users/{id}/account-access-list
Query all user account access objects.
You can provide the page and size to get the desired list of account access. Max page size limit: 5000
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | ID can be either internal Vroozi ID or External System ID. If using externalId, the header key useExternalId should be passed as true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Account Access list returned. |
AccountAccessPageModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
Customer or any reference object couldn’t be found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Update Account Access List
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/users/{id}/account-access-list \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}/account-access-list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}/account-access-list',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/users/{id}/account-access-list', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/users/{id}/account-access-list',
params: {
}, headers: headers
p JSON.parse(result)
PUT /users/{id}/account-access-list
Update list of User Account Access by Id using replace update strategy.
You can either provide system generated Id or externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Maximum 5000 records are allowed in the request body. A validation error is returned if the payload exceed this limit.
Body parameter
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | ID can be either internal Vroozi ID or External System ID. If using externalId, the header key useExternalId should be passed as true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body AccountAccessListModelrequired |
body | No description |
Example responses
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Account Access List has been updated. |
AccountAccessListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Upsert Account Access List
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/users/{id}/account-access-list \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}/account-access-list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}/account-access-list',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.post('https://api.vroozi.com/v1/users/{id}/account-access-list', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.post 'https://api.vroozi.com/v1/users/{id}/account-access-list',
params: {
}, headers: headers
p JSON.parse(result)
POST /users/{id}/account-access-list
list of User Account Access by Id using merge update strategy.
You can either provide system generated Id or externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Maximum 5000 records are allowed in the request body. A validation error is returned if the payload exceed this limit.
Body parameter
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | ID can be either internal Vroozi ID or External System ID. If using externalId, the header key useExternalId should be passed as true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body AccountAccessListModelrequired |
body | No description |
Example responses
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Account Access List has been updated. |
AccountAccessListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
Delete Account Access List
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/users/{id}/account-access-list \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/users/{id}/account-access-list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/users/{id}/account-access-list',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/users/{id}/account-access-list', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/users/{id}/account-access-list',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /users/{id}/account-access-list
Delete list of User Account Access by user Id.
You can either provide system generated Id or externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Maximum 5000 records are allowed in the request body. A validation error is returned if the payload exceed this limit.
Body parameter
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
id stringrequired |
path | ID can be either internal Vroozi ID or External System ID. If using externalId, the header key useExternalId should be passed as true |
useExternalId string |
header | If true id parameter should be externalId else should be id |
body AccountAccessListModelrequired |
body | No description |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Unauthorized"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Account Access List has been updated. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Invalid action. |
GenericErrorModel |
404 |
User id not found. |
ErrorDataModel |
500 |
Something went wrong. Actual error message will be available in the response body |
ErrorDataModel |
WBS Elements
List WBS Elements
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/wbs-elements \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/wbs-elements', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/wbs-elements',
params: {
}, headers: headers
p JSON.parse(result)
GET /wbs-elements
Query all wbs elements.
If the lastUpdatedAfter parameter is provided, then it will return the list of wbs elements updated after that date.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
You can also provide the page and size to get the desired list of wbs elements. Max page size limit: 100
Parameters
| Parameter | In | Description |
|---|---|---|
lastUpdatedAfter string |
query | Last updated date to filter list. The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset). The URL should be encoded if the time-zone offset is positive. Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500 |
page integer |
query | Page number (per the size provided) of the returned results. Accepted values: page, Page |
size integer |
query | Number of records to return per page. Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size |
Detailed descriptions
lastUpdatedAfter: Last updated date to filter list.
The dates should be in UTC Format: yyyy-MM-dd (without time and time-zone offset) or yyyy-MM-dd’T’hh:mm:ss:SSSZ (with time and time-zone offset).
The URL should be encoded if the time-zone offset is positive.
Example: 2018-04-05T10:53:29.000, 2018-04-05T10:53:29.000-0500, 2018-04-05T10:53:29.000+0500 should be encoded as 2018-04-05T10:53:29.000%2B0500
page: Page number (per the size provided) of the returned results. Accepted values: page, Page
size: Number of records to return per page.
Default value is 25, and maximum 100 records can be requested per page. Accepted values: size, Size
Example responses
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
WBS elements list returned. |
WBSElementListModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create WBS Element
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/wbs-elements \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/wbs-elements', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/wbs-elements',
params: {
}, headers: headers
p JSON.parse(result)
POST /wbs-elements
Create a new WBS Element
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body WBSElementModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
201 |
WBS Element has been created. |
WBSElementModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
WBS Element or any reference object couldn’t be found. |
Inline |
409 |
WBS Element contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Upsert WBS Element
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/wbs-elements/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements/upsert',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/wbs-elements/upsert', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/wbs-elements/upsert',
params: {
}, headers: headers
p JSON.parse(result)
POST /wbs-elements/upsert
Create/Update WBS Element.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
body WBSElementModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
WBS Element is updated successfully. |
WBSElementModel |
201 |
WBS Element is created successfully. |
WBSElementModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
WBS Element or any reference object couldn’t be found. |
Inline |
409 |
WBS Element contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Create or Update the WBS Element in bulk asynchronously
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async',
params: {
}, headers: headers
p JSON.parse(result)
POST /wbs-elements/bulk-upsert/async
Create or Update the WBS Element in bulk asynchronously.
The payload supports 10MB data, but it’s recommended to keep it under 10,000 records for optimal performance.
Body parameter
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Parameters
| Parameter | In | Description |
|---|---|---|
body array[object]required |
body | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The WBS Element bulk upsert async request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Company code or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Bulk Upsert WBS element Retry
Code samples
You can also use wget
curl -X POST https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async/retry?trackingId=string \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async/retry?trackingId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async/retry?trackingId=string',
{
method: 'POST',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async/retry', params={
'trackingId': 'string'
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.vroozi.com/v1/wbs-elements/bulk-upsert/async/retry',
params: {
'trackingId' => 'string'
}, headers: headers
p JSON.parse(result)
POST /wbs-elements/bulk-upsert/async/retry
This endpoint allows you to re-trigger the failed asynchronous bulk upsert request.
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
query | No description |
Example responses
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
202 |
The WBS Element bulk upsert async retry request was received successfully. |
VrooziApiAsyncResponseModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get progress status of the bulk upsert WBS Element by Tracking ID
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/wbs-elements/bulk-upsert/{trackingId}/status \
-H 'Accept: application/json'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/bulk-upsert/{trackingId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/{trackingId}/status',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.vroozi.com/v1/wbs-elements/bulk-upsert/{trackingId}/status', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.vroozi.com/v1/wbs-elements/bulk-upsert/{trackingId}/status',
params: {
}, headers: headers
p JSON.parse(result)
GET /wbs-elements/bulk-upsert/{trackingId}/status
Get progress status of the bulk upsert WBS Element by Tracking ID
Parameters
| Parameter | In | Description |
|---|---|---|
trackingId stringrequired |
path | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/wbs-elements/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "WBS_ELEMENT",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"channel": "CHA-1",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "ERROR"
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
Status of Async Bulk Upload request. |
Inline |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
Tracking request or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Get WBS Element
Code samples
You can also use wget
curl -X GET https://api.vroozi.com/v1/wbs-elements/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/wbs-elements/{id}',
{
method: 'GET',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.get('https://api.vroozi.com/v1/wbs-elements/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.get 'https://api.vroozi.com/v1/wbs-elements/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /wbs-elements/{id}
Get wbs element by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
WBS Element object returned. |
WBSElementModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
WBS Element or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Update WBS Element
Code samples
You can also use wget
curl -X PUT https://api.vroozi.com/v1/wbs-elements/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const inputBody = '{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/wbs-elements/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.put('https://api.vroozi.com/v1/wbs-elements/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.put 'https://api.vroozi.com/v1/wbs-elements/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /wbs-elements/{id}
Update WBS Element by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Note: During an update request, only the fields provided in the payload will be updated. Any field not included in the payload will retain its previous value. To reset a field’s value, include that field in the payload with a value of null or an empty string.
Body parameter
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
body WBSElementModelrequired |
body | No description |
Example responses
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "409",
"title": "Conflict",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "409",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
WBS Element has been updated. |
WBSElementModel |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
WBS Element or any reference object couldn’t be found. |
Inline |
409 |
WBS Element contains duplicate information. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Delete WBS Element
Code samples
You can also use wget
curl -X DELETE https://api.vroozi.com/v1/wbs-elements/{id} \
-H 'Accept: application/json' \
-H 'useExternalId: string'
URL obj = new URL("https://api.vroozi.com/v1/wbs-elements/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const request = require('node-fetch');
const headers = {
'Accept':'application/json',
'useExternalId':'string'
};
fetch('https://api.vroozi.com/v1/wbs-elements/{id}',
{
method: 'DELETE',
headers: headers
})
.then(res => res.json())
.then(body => console.log(body));
import requests
headers = {
'Accept': 'application/json',
'useExternalId': 'string'
}
r = requests.delete('https://api.vroozi.com/v1/wbs-elements/{id}', params={
}, headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'useExternalId' => 'string'
}
result = RestClient.delete 'https://api.vroozi.com/v1/wbs-elements/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /wbs-elements/{id}
Delete wbs element by ID.
You can either provide system generated ID or your provided externalId.
When passing externalId as an id in the request url, its required to send the request header useExternalId with value of true.
Parameters
| Parameter | In | Description |
|---|---|---|
useExternalId string |
header | If true id parameter should be externalId else should be id |
id stringrequired |
path | Id or externalId in case that isExternalId is true |
Example responses
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"message": "Unauthorized"
}
{
"message": "Forbidden"
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "404",
"title": "Not Found",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "404",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "500",
"title": "Internal Server Error",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "500",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Responses
| Status | Description | Schema |
|---|---|---|
200 |
WBS Element has been deleted. |
None |
400 |
Data validation failed. Please check your data and send the request again. |
ErrorDataModel |
401 |
Authorization failed. |
GenericErrorModel |
403 |
Forbidden (The server understood the request but refuses to authorise it). |
Inline |
404 |
WBS Element or any reference object couldn’t be found. |
Inline |
500 |
Something went wrong. Actual error message will be available in the response body |
Inline |
Schemas
AccountAccessListModel
[
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
Properties
| Name | Description |
|---|---|
Account Access List Model [object] |
No description |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
GlAccountModel |
AccountAccessPageModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Account Access Model objects |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
GlAccountModel |
AccountingComboListModel
[
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
Properties
| Name | Description |
|---|---|
List of Accounting Strings [object] |
List of Accounting Strings. |
Accounting Strings object |
A representation of accounting strings |
id string |
System generated unique identifier for this object. |
externalId string |
External system generated accounting strings id to uniquely identify a given accounting strings. |
name string |
Unique Name to identify Accounting Strings. Can be provided by the user or generated by the system if not provided |
description string |
Description for this Accounting Strings. |
accountingElement objectrequired |
A representation of accounting element. These elements are used for validating accounting strings. |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
Flag to indicate the accounting strings is active or inactive |
effectiveStartDate string(date-time) |
After this date the accounting strings will be active. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
effectiveEndDate string(date-time) |
After this date the accounting strings will be inactive. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
AccountingComboModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
External system generated accounting strings id to uniquely identify a given accounting strings. |
name string |
Unique Name to identify Accounting Strings. Can be provided by the user or generated by the system if not provided |
description string |
Description for this Accounting Strings. |
accountingElement objectrequired |
A representation of accounting element. These elements are used for validating accounting strings. |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
Flag to indicate the accounting strings is active or inactive |
effectiveStartDate string(date-time) |
After this date the accounting strings will be active. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
effectiveEndDate string(date-time) |
After this date the accounting strings will be inactive. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
AccountingComboPageModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Accounting Strings. |
Accounting Strings object |
A representation of accounting strings |
id string |
System generated unique identifier for this object. |
externalId string |
External system generated accounting strings id to uniquely identify a given accounting strings. |
name string |
Unique Name to identify Accounting Strings. Can be provided by the user or generated by the system if not provided |
description string |
Description for this Accounting Strings. |
accountingElement objectrequired |
A representation of accounting element. These elements are used for validating accounting strings. |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
Flag to indicate the accounting strings is active or inactive |
effectiveStartDate string(date-time) |
After this date the accounting strings will be active. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
effectiveEndDate string(date-time) |
After this date the accounting strings will be inactive. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
AccountingElementModel
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
}
Properties
| Name | Description |
|---|---|
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
AcknowledgementStatusUpdateModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"docNo": "3000000614",
"status": "SUCCESS",
"comments": "Sample comment"
}
Properties
| Name | Description |
|---|---|
id string |
This ID field will be used to lookup the document for status update. It should be a valid ID in Vroozi system. |
externalId string |
Client can pass unique ID generated in their system for this document in this field to update it in Vroozi. This field should be unique per document in Vroozi system. |
docNo string |
Client can pass docNo instead of id to perform a lookup for the actual document. The docNo should be valid number for this document in Vroozi. |
status stringrequired |
The status recieved in the acknowledgement |
comments string |
Comments. |
Enumerated Values
| Property | Value |
|---|---|
status |
SUCCESS |
status |
FAILED |
AddressListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of addresses. |
Address object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
addressType |
shipping |
addressType |
billing |
addressType |
company |
AddressModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
addressType |
shipping |
addressType |
billing |
addressType |
company |
ApprovalGroupListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Approval Groups. |
Approval Group object |
A representation of the Approval Group |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this approval groups for business use. |
channel stringrequired |
Channel of this approval groups for business use. |
description stringrequired |
Description for this approval group. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this approval groups is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
ApprovalGroupModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this approval groups for business use. |
channel stringrequired |
Channel of this approval groups for business use. |
description stringrequired |
Description for this approval group. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this approval groups is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
AsyncBulkUploadRequestModel
{
"payload": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
payload [object] |
Array of Accounting Strings. |
Accounting Strings object |
A representation of accounting strings |
id string |
System generated unique identifier for this object. |
externalId string |
External system generated accounting strings id to uniquely identify a given accounting strings. |
name string |
Unique Name to identify Accounting Strings. Can be provided by the user or generated by the system if not provided |
description string |
Description for this Accounting Strings. |
accountingElement objectrequired |
A representation of accounting element. These elements are used for validating accounting strings. |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
Flag to indicate the accounting strings is active or inactive |
effectiveStartDate string(date-time) |
After this date the accounting strings will be active. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
effectiveEndDate string(date-time) |
After this date the accounting strings will be inactive. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
AsyncBulkUploadResponseModel
{
"requestId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
requestId string |
System generated id to uniquely identify bulk upload request |
status string |
Status of the bulk upload request |
timestamp string(date-time) |
Time of the bulk upsert request recieved Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
AsyncBulkUploadStatusModel
{
"requestId": "5abb-d758e6-1c824a",
"status": "IN_PROGRESS",
"updates": {
"total": 10,
"success": 5,
"failed": 5
},
"payload": [
{
"accountingCombo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"name": "Accounting Strings 1",
"description": "Sample description",
"accountingElement": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"purchasingOrganizationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
}
},
"active": true,
"effectiveStartDate": "2023-03-15T13:56:04.037+0000",
"effectiveEndDate": "2023-04-05T13:56:04.037+0000",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "SUCCESS"
}
]
}
Properties
| Name | Description |
|---|---|
requestId string |
System generated unique identifier for this object. |
status string |
Status of Async Bulk Upload |
updates object |
A representation of async bulk upload request metadata |
total number |
Total combination in request |
success number |
Number of successes operations |
failed number |
Number of failed operations |
payload [object] |
No description |
Accounting Strings Detail object |
A detail representation of accounting strings |
accountingCombo object |
A representation of accounting strings |
id string |
System generated unique identifier for this object. |
externalId string |
External system generated accounting strings id to uniquely identify a given accounting strings. |
name string |
Unique Name to identify Accounting Strings. Can be provided by the user or generated by the system if not provided |
description string |
Description for this Accounting Strings. |
accountingElement objectrequired |
A representation of accounting element. These elements are used for validating accounting strings. |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrganizationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
Flag to indicate the accounting strings is active or inactive |
effectiveStartDate string(date-time) |
After this date the accounting strings will be active. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
effectiveEndDate string(date-time) |
After this date the accounting strings will be inactive. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
errors [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
status string |
Status of Async Bulk Upload |
Enumerated Values
| Property | Value |
|---|---|
status |
IN_PROGRESS |
status |
ERROR |
status |
COMPLETED |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
LocationModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
status |
SUCCESS |
status |
FAILED |
AsyncCatalogItemUploadRequestModel
{
"payload": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
Properties
| Name | Description |
|---|---|
payload [object]required |
Listing of catalog items |
Catalog Item object |
A representation of Catalog Item |
id string |
System generated unique identifier for this object (Read only). |
catalogRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemNumber integer |
System generated serial number for items (Read only). |
status string |
Item’s current status (Read only). |
description stringrequired |
Description of this catalog item You might see NEW_ITEM-DESCRIPTION in reports and ‘Short Description’ in the smartOCI user interface which represents description field in the API. |
productId string |
SRM product number of the item You might see NEW_ITEM-MATNR in reports and ‘NEW_ITEM-MATNR’ in the smartOCI user interface which represents productId field in the API. |
quantity number |
Item Quantity You might see NEW_ITEM-QUANTITY in reports which represents quantity field in the API. |
uom stringrequired |
Unit of measure for items e.g., Dozen, Box etc. You might see NEW_ITEM-UNIT in reports and ‘Unit of Measure’ in the smartOCI user interface which represents uom field in the API. |
priceUnit string |
Price of an item per price unit You might see NEW_ITEM-PRICEUNIT in reports and ‘Price Unit’ in the smartOCI user interface which represents priceUnit field in the API. |
currency stringrequired |
Currency of item price. You might see NEW_ITEM-CURRENCY in reports and ‘Currency’ in the smartOCI user interface which represents currency field in the API. |
leadTime string |
Delivery time of the item in days You might see NEW_ITEM-LEADTIME in reports and ‘Lead Time’ in the smartOCI user interface which represents leadTime field in the API. |
vendorId string |
Unique Supplier ID as assigned by SmartOCI You might see NEW_ITEM-VENDOR in reports and ‘Supplier’ in the smartOCI user interface which represents vendorId field in the API. |
partNumber stringrequired |
Supplier’s product number for the item You might see NEW_ITEM-VENDORMAT in reports and ‘Vendor Part Number’ in the smartOCI user interface which represents partNumber field in the API. |
manufacturerCode string |
SRM manufacturer number of the item You might see NEW_ITEM-MANUFACTCODE in reports which represents manufacturerCode field in the API. |
manufacturerPartNo string |
Item’s manufacturer part number You might see NEW_ITEM-MANUFACTMAT in reports and ‘Manufacturer Part Number’ in the smartOCI user interface which represents manufacturerPartNo field in the API. |
contract string |
SRM contract to which the item refers You might see NEW_ITEM-CONTRACT in reports and ‘Contract’ in the smartOCI user interface which represents contract field in the API. |
contractItem string |
Item within the SRM contract You might see NEW_ITEM-CONTRACT_ITEM in reports and ‘Contract Line Item’ in the smartOCI user interface which represents contractItem field in the API. |
externalQuoteId string |
Number of an external bid for this item (as reference for a subsequent purchase order) You might see NEW_ITEM-EXT_QUOTE_ID in reports which represents externalQuoteId field in the API. |
externalQuoteItem string |
Item of external bid You might see NEW_ITEM-EXT_QUOTE_ITEM in reports which represents externalQuoteItem field in the API. |
category stringrequired |
SRM material group for the item You might see NEW_ITEM-MATGROUP in reports and ‘Category’ in the smartOCI user interface which represents category field in the API. |
longDescription string |
Long text for the item You might see NEW_ITEM-LONGTEXT in reports and ‘LONG DESCRIPTION’ in the smartOCI user interface which represents longDescription field in the API |
customUserAttributes [object] |
No description |
Custom User Attribute Model object |
A representation of custom user attributes. |
fieldName string |
Custom attribute name. |
fieldValue string |
Custom attribute value |
attachmentUrl string |
URL of the attachment (the attachment must be accessible for downloading under this URL) |
attachmentTitle string |
Title of the attachment (if this is empty the file name from the URL above is used) You might see NEW_ITEM-ATTACHMENT_TITLE in reports which represents attachmentTitle field in the API |
attachmentPurpose string |
Purpose of the attachment. Corresponds here to configuration. You might see NEW_ITEM-ATTACHMENT_PURPOSE in reports which represents attachmentPurpose field in the API |
externalSchemaType string |
Name of a schema via which it was imported in the SRM Server You might see NEW_ITEM-EXT_SCHEMA_TYPE in reports and ‘NEW_ITEM-EXT_SCHEMA_TYPE’ in the smartOCI user interface which represents externalSchemaType field in the API |
externalCatagoryId string |
Unique key for an external category from the schema above, independent of the version of the schema You might see NEW_ITEM-EXT_CATEGORY_ID in reports and ‘NEW_ITEM-EXT_CATEGORY_ID’ in the smartOCI user interface which represents externalCatagoryId field in the API |
externalCatagory string |
Unique key for an external category from the schema above, dependent on the version of the schema You might see NEW_ITEM-EXT_CATEGORY in reports and ‘NEW_ITEM-EXT_CATEGORY’ in the smartOCI user interface which represents externalCatagory field in the API |
sldSysName string |
Name of a system in the System Landscape Directory (SLD) You might see NEW_ITEM-SLD_SYS_NAME in reports and ‘NEW_ITEM-SLD_SYS_NAME’ in the smartOCI user interface which represents sldSysName field in the API |
quoteQuantity string |
Quantity of item in a quote You might see ITEM-QUOTE_QUANTITY in reports which represents quoteQuantity field in the API |
bundleQuantity string |
Quantity of item in a bundle BundleQuantity is required if the BundleNumber field is given. You might see ITEM-BUNDLE_QUANTITY in reports and ‘Bundle Quantity’ in the smartOCI user interface which represents bundleQuantity field in the API |
price stringrequired |
Price of item parsed according to currency code and preferred locale You might see NEW_ITEM-PRICE in reports and ‘Price’ in the smartOCI user interface which represents price field in the API. |
tieredPricing string |
Price of item in multiple tiers based upon quantity tieredPricing cannot be specified if BundleNo is given. You might see ITEM-TIERED_PRICING in reports and ‘Tiered Pricing’ in the smartOCI user interface which represents tieredPricing field in the API |
bundleNo string |
Numeric value indicating it is part of a bundle BundleNo cannot be specified if tieredPricing is given. You might see ITEM-BUNDLE_NO in reports and ‘Bundle Number’ in the smartOCI user interface which represents bundleNo field in the API |
greenItem boolean |
true or false (whether this item is environment friendly or not) You might see ITEM-GREEN_ITEM in reports which represents greenItem field in the API |
bundleName string |
It is (Read only) field |
bundleRequired boolean |
It is (Read only) field |
itemInStock string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-INSTOCK in reports which represents itemInStock field in the API. |
quantityOnHand string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-QTY_ONHAND in reports and ‘Quantity on Hand’ in the smartOCI user interface which represents quantityOnHand field in the API |
manufacturerName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MANUFACTURER_NAME in reports and ‘Manufacturer Name’ in the smartOCI user interface which represents manufacturerName field in the API |
brandName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-BRAND_NAME in reports and ‘Brand Name’ in the smartOCI user interface which represents brandName field in the API |
minOrderQuantity string |
Minimum item quantity that must be ordered If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-MIN_ORDER_QTY in reports and ‘Minimum Order Quantity’ in the smartOCI user interface which represents minOrderQuantity field in the API |
modelNo string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MODELNO in reports and ‘Model No’ in the smartOCI user interface which represents modelNo field in the API |
upc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-UPC in reports which represents upc field in the API |
caseUpc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-CASE_UPC in reports which represents caseUpc field in the API |
listPrice string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-LIST_PRICE in reports and ‘List Price’ in the smartOCI user interface which represents listPrice field in the API |
attributeModel object |
A representation of additional product attributes. |
color string |
Predefined custom field whose value can be provided in catalog file |
size string |
Predefined custom field whose value can be provided in catalog file |
gender string |
Predefined custom field whose value can be provided in catalog file |
ram string |
Predefined custom field whose value can be provided in catalog file |
cpu string |
Predefined custom field whose value can be provided in catalog file |
hdd string |
Predefined custom field whose value can be provided in catalog file |
screenSize string |
Predefined custom field whose value can be provided in catalog file |
screenResolution string |
Predefined custom field whose value can be provided in catalog file |
comments string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-COMMENTS in reports which represents comments field in the API |
energyStar boolean |
Whether this item has “energy star” attribute associated You might see ITEM-ENERGY_STAR in reports which represents energyStar field in the API |
freeShippingAvailable boolean |
Whether this item has “free shipping” attribute associated |
clearance boolean |
Whether this item has “clearance” attribute associated You might see ITEM-CLEARANCE in reports which represents clearance field in the API |
onSale boolean |
Whether this item has “on sale” attribute associated You might see ITEM-ON_SALE in reports which represents onSale field in the API |
preferred boolean |
Whether this item has “preferred” attribute associated You might see ITEM-PREFERRED in reports which represents preferred field in the API |
refurbished boolean |
Whether this item has “refurb” attribute associated You might see ITEM-REFURB in reports which represents refurbished field in the API |
contractAssoicated boolean |
Whether this item has “contract” attribute associated You might see ITEM-CONTRACT in reports which represents contractAssoicated field in the API |
rohsAssociated boolean |
Whether this item has “rohs” attribute associated You might see ITEM-ROHS in reports which represents rohsAssociated field in the API |
orderInterval string |
Interval by which quantity should be increased/decreased If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-ORDER_INTERVAL in reports and ‘Order Interval’ in the smartOCI user interface which represents orderInterval field in the API |
suppressPrice boolean |
Whether price of this item can be seen You might see ITEM-SUPPRESS_PRICE in reports and ‘Suppress Price’ in the smartOCI user interface which represents suppressPrice field in the API |
orderMultiplyQuantity string |
It is readonly field |
rating number |
Rating score of an item |
ratingCount integer |
Number of ratings for an item |
priceEditable boolean |
Is the item’s price editable You might see ITEM-PRICE_EDITABLE in reports and ‘Price Editable’ in the smartOCI user interface which represents priceEditable field in the API |
itemSuppress boolean |
Whether this item is read only and can’t be added to cart You might see ITEM-SUPPRESS in reports and ‘Item Suppress’ in the smartOCI user interface which represents itemSuppress field in the API |
externalId string |
Unique database key for this item in the catalog (Read Only) |
itemGlAccount string |
Item GL account You might see ITEM-GL_ACCOUNT in reports and ‘Item GL Account’ in the smartOCI user interface which represents itemGlAccount field in the API |
itemConfig boolean |
Whether this item should be ordered from Supplier You might see ITEM-CONFIG in reports and ‘Configurable Item’ in the smartOCI user interface which represents configurable field in the API |
itemPolicy boolean |
Whether this item represents supplier info only You might see ITEM-POLICY in reports and ‘Item Policy’ in the smartOCI user interface which represents itemPolicy field in the API |
newItemService boolean |
Flag for item service, (if true, the item will be considered SERVICE else PRODUCT) You might see NEW_ITEM-SERVICE in reports which represents newItemService field in the API |
dateCreated string(date) |
Date Catalog Item Created (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
lastUpdated string(date) |
Date Catalog Item Last Updated (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
customFields [object] |
No description |
OCI Item Custom Field object |
A representation of oci catalog item custom fields. |
customFieldId string |
Id of associated custom field |
priceAdder string |
Price Adder |
value string |
Value of the field |
fieldName string |
Friendly name of the field |
fieldType string |
Data type of the field |
active string |
Is the field active? |
displayOrder string |
Order of display |
includeInPO string |
Whether this custom field should be included in Purchase Order |
tieredPrices [object] |
No description |
Tiered Price Model object |
A representation of tiered prices |
id string |
Id associated with Tiered Price |
from string |
No description |
to string |
No description |
price string |
No description |
images [object] |
No description |
OCI Item Image object |
A representation of oci catalog images. |
fileResourceId string |
Image File Resource Id |
fileResourceBase string |
Resource Base |
fileResourceOrig string |
No description |
createdDate string(date) |
Date Catalog Item Image Created. Date should be in UTC in following format: yyyy-MM-dd. |
fieldType string |
Data type of the image |
fileName string |
Name of File |
fileTag string |
Tag of Image |
unitId string |
Resource Unit Id |
fileImagesOrig string |
Image File Origin |
Enumerated Values
| Property | Value |
|---|---|
type |
CatalogModel |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
PUBLISHED |
AsyncCatalogStatusUpdateRequestModel
{
"payload": {
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
}
Properties
| Name | Description |
|---|---|
payload objectrequired |
A representation of catalog update model. This is used to update the status of Catalog. Catalog would be identified based on either id, externalId or docNo in the priority order. |
comments string |
Catalog status |
action stringrequired |
In case of ACTIVATE or DEACTIVATE action, the catalog’s status is not changed, only the ‘active’ flag of catalog is updated to either ‘true’ or ‘false’. For all other actions, catalog status is updated. |
submitterRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
action |
APPROVE |
action |
ACTIVATE |
action |
PUBLISH |
action |
DISAPPROVE |
action |
DEACTIVATE |
action |
REJECT |
action |
UNPUBLISH |
type |
UserModel |
AsyncRequestModel
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"processingResult": [
{
"payload": {
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"active": true
},
"status": "SUCCESS",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"warnings": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
],
"updates": {
"total": 10,
"success": 5,
"unchanged": 5,
"failed": 5
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
trackingId string |
System generated id to uniquely identify budget status update request |
processingResult [object] |
Array of async request detail. |
Async Request Tracking object |
A representation of tracking progress of async requests. |
payload object |
A representation of tracking progress of async requests. |
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
No description |
status string |
Async Operation Status of Budget Reference |
errors [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
warnings [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
updates object |
A representation of async bulk request metadata |
total number |
Total combination in request |
success number |
Number of successes operations |
unchanged number |
Number of unchanged operations |
failed number |
Number of failed operations |
status string |
Processing status of Async Request |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
BudgetModel |
status |
SUCCESS |
status |
UNCHANGED |
status |
FAILED |
status |
IN_PROGRESS |
status |
ERROR |
status |
COMPLETED |
status |
COMPLETED_WITH_FAILURE |
status |
COMPLETED_WITH_WARNING |
AsyncRequestTrackingModel
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "status-update",
"requestMethod": "status-update",
"processingStatus": "IN_PROGRESS",
"metadata": {
"catalogId": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"catalogName": "Summer'18 Catalog",
"version": 2,
"active": true,
"states": {
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"totalItems": 505,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55
},
"catalogStatus": "PUBLISHED"
},
"newVersionMetadata": {
"catalogId": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"catalogName": "Summer'18 Catalog",
"version": 2,
"active": true,
"states": {
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"totalItems": 505,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55
},
"catalogStatus": "PUBLISHED"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"errorReportLink": "https://admin.vroozi.com/adminui/view-error-report?catId=65014b34778f4a6305233ea2",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
trackingId string |
System generated id to uniquely identify catalog status update request |
requestPath string |
Path of the actual async API related to this tracking request. |
requestMethod string |
Request method used for the actual API, e.g GET, PUT, POST, DELETE etc. |
processingStatus string |
Processing status of Async Request |
metadata object |
A representation of Catalog metadata |
catalogId string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
catalogName string |
Catalog’s name. |
version integer |
Version number of the catalog (Read only). |
active boolean |
This flag indicates whether or not this catalog is available for use. Active true means its available, otherwise not. This field is read only. |
states object |
A representation of Catalog item states |
approvedItemsCount integer |
Number of items which are approved by the approver (Read only). |
rejectedItemsCount integer |
Number of items which are rejected by the approver (Read only). |
pendingItemsCount integer |
Number of items which are pending approval (Read only). |
totalItems integer |
Total number of item in the catalog (Read only). |
publishedItemsCount integer |
Number of items which are published (Read only). |
inputRecordsCount integer |
Number of records parsed from uploaded request payload (Read only). |
outputRecordsCount integer |
Number of records successfully saved in database (Read only). |
failedRecordsCount integer |
Number of records that couldn’t be saved (Read only). |
catalogStatus string |
Catalog’s status. This field is read only. |
newVersionMetadata object |
A representation of Catalog metadata |
catalogId string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
catalogName string |
Catalog’s name. |
version integer |
Version number of the catalog (Read only). |
active boolean |
This flag indicates whether or not this catalog is available for use. Active true means its available, otherwise not. This field is read only. |
states object |
A representation of Catalog item states |
approvedItemsCount integer |
Number of items which are approved by the approver (Read only). |
rejectedItemsCount integer |
Number of items which are rejected by the approver (Read only). |
pendingItemsCount integer |
Number of items which are pending approval (Read only). |
totalItems integer |
Total number of item in the catalog (Read only). |
publishedItemsCount integer |
Number of items which are published (Read only). |
inputRecordsCount integer |
Number of records parsed from uploaded request payload (Read only). |
outputRecordsCount integer |
Number of records successfully saved in database (Read only). |
failedRecordsCount integer |
Number of records that couldn’t be saved (Read only). |
catalogStatus string |
Catalog’s status. This field is read only. |
errors [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
errorReportLink string |
URL to download the generated error report for the async request. |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
processingStatus |
IN_PROGRESS |
processingStatus |
ERROR |
processingStatus |
COMPLETED |
processingStatus |
COMPLETE_WITH_ERROR |
catalogStatus |
NEW |
catalogStatus |
UPDATED |
catalogStatus |
REJECTED |
catalogStatus |
ERROR_REJECTING |
catalogStatus |
APPROVED |
catalogStatus |
ERROR_APPROVING |
catalogStatus |
PUBLISHED |
catalogStatus |
ERROR_PUBLISHING |
catalogStatus |
UNPUBLISHED |
catalogStatus |
ERROR_UNPUBLISHING |
catalogStatus |
DISAPPROVED |
catalogStatus |
ERROR_DISAPPROVING |
catalogStatus |
NEW |
catalogStatus |
UPDATED |
catalogStatus |
REJECTED |
catalogStatus |
ERROR_REJECTING |
catalogStatus |
APPROVED |
catalogStatus |
ERROR_APPROVING |
catalogStatus |
PUBLISHED |
catalogStatus |
ERROR_PUBLISHING |
catalogStatus |
UNPUBLISHED |
catalogStatus |
ERROR_UNPUBLISHING |
catalogStatus |
DISAPPROVED |
catalogStatus |
ERROR_DISAPPROVING |
AsyncResponseModel
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
trackingId string |
System generated id to uniquely identify catalog status update request |
status string |
Status of the catalog status update request |
timestamp string(date-time) |
Time of the catalog status update request recieved Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
AttachmentModel
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
BudgetAssociationListModel
[
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
]
Properties
| Name | Description |
|---|---|
Budget Association List [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
BudgetAssociationModel
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
Properties
| Name | Description |
|---|---|
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
BudgetListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Budgets. |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Budget name |
description string |
Description for this budget |
totalAmount numberrequired |
Total amount of budget |
budgetAssociations [object]required |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
durationType stringrequired |
Available types of Durations. Should be one of the following: WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, YEARLY, CUSTOM_PERIOD |
currency stringrequired |
Budget currency (Read only). This value is populated from the company’s default currency set by the administrator. |
overBudgetAction stringrequired |
Available types of actions. Should be one of the following: ALLOW_WITHOUT_APPROVAL, ALLOW_WITH_APPROVAL, RESTRICT |
budgetApproverRefs [allOf] |
List of budget approvers, who can approve this budget if the over budget requires approval for submission of requisitions. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
fromDate string(date-time)required |
Start date of the budget. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
toDate string(date-time)required |
Last updated date of the budget. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
active boolean |
The budget is active (Read only). This flag indicates whether or not this budget is available for use. Active true means it’s available, otherwise not. During the creation of the budget, if the current date is between fromDate and toDate the active will be true, otherwise, it is marked as false. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
durationType |
WEEKLY |
durationType |
MONTHLY |
durationType |
QUARTERLY |
durationType |
SEMI_ANNUALLY |
durationType |
YEARLY |
durationType |
CUSTOM_PERIOD |
overBudgetAction |
ALLOW_WITHOUT_APPROVAL |
overBudgetAction |
ALLOW_WITH_APPROVAL |
overBudgetAction |
RESTRICT |
type |
UserModel |
BudgetModel
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"name": "1234",
"description": "sample description",
"totalAmount": 20.3,
"budgetAssociations": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel'",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel'",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel'",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel'",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel'",
"label": "Description for label",
"archived": false
}
}
],
"durationType": "WEEKLY",
"currency": "USD",
"overBudgetAction": "RESTRICT",
"budgetApproverRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
],
"fromDate": "2018-03-15T13:56:04.037+0000",
"toDate": "2018-04-05T13:56:04.037+0000",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Budget name |
description string |
Description for this budget |
totalAmount numberrequired |
Total amount of budget |
budgetAssociations [object]required |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
durationType stringrequired |
Available types of Durations. Should be one of the following: WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, YEARLY, CUSTOM_PERIOD |
currency stringrequired |
Budget currency (Read only). This value is populated from the company’s default currency set by the administrator. |
overBudgetAction stringrequired |
Available types of actions. Should be one of the following: ALLOW_WITHOUT_APPROVAL, ALLOW_WITH_APPROVAL, RESTRICT |
budgetApproverRefs [allOf] |
List of budget approvers, who can approve this budget if the over budget requires approval for submission of requisitions. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
fromDate string(date-time)required |
Start date of the budget. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
toDate string(date-time)required |
Last updated date of the budget. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
active boolean |
The budget is active (Read only). This flag indicates whether or not this budget is available for use. Active true means it’s available, otherwise not. During the creation of the budget, if the current date is between fromDate and toDate the active will be true, otherwise, it is marked as false. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
CustomerModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
durationType |
WEEKLY |
durationType |
MONTHLY |
durationType |
QUARTERLY |
durationType |
SEMI_ANNUALLY |
durationType |
YEARLY |
durationType |
CUSTOM_PERIOD |
overBudgetAction |
ALLOW_WITHOUT_APPROVAL |
overBudgetAction |
ALLOW_WITH_APPROVAL |
overBudgetAction |
RESTRICT |
type |
UserModel |
CatalogItemListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of catalog items. |
Catalog Item object |
A representation of Catalog Item |
id string |
System generated unique identifier for this object (Read only). |
catalogRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemNumber integer |
System generated serial number for items (Read only). |
status string |
Item’s current status (Read only). |
description stringrequired |
Description of this catalog item You might see NEW_ITEM-DESCRIPTION in reports and ‘Short Description’ in the smartOCI user interface which represents description field in the API. |
productId string |
SRM product number of the item You might see NEW_ITEM-MATNR in reports and ‘NEW_ITEM-MATNR’ in the smartOCI user interface which represents productId field in the API. |
quantity number |
Item Quantity You might see NEW_ITEM-QUANTITY in reports which represents quantity field in the API. |
uom stringrequired |
Unit of measure for items e.g., Dozen, Box etc. You might see NEW_ITEM-UNIT in reports and ‘Unit of Measure’ in the smartOCI user interface which represents uom field in the API. |
priceUnit string |
Price of an item per price unit You might see NEW_ITEM-PRICEUNIT in reports and ‘Price Unit’ in the smartOCI user interface which represents priceUnit field in the API. |
currency stringrequired |
Currency of item price. You might see NEW_ITEM-CURRENCY in reports and ‘Currency’ in the smartOCI user interface which represents currency field in the API. |
leadTime string |
Delivery time of the item in days You might see NEW_ITEM-LEADTIME in reports and ‘Lead Time’ in the smartOCI user interface which represents leadTime field in the API. |
vendorId string |
Unique Supplier ID as assigned by SmartOCI You might see NEW_ITEM-VENDOR in reports and ‘Supplier’ in the smartOCI user interface which represents vendorId field in the API. |
partNumber stringrequired |
Supplier’s product number for the item You might see NEW_ITEM-VENDORMAT in reports and ‘Vendor Part Number’ in the smartOCI user interface which represents partNumber field in the API. |
manufacturerCode string |
SRM manufacturer number of the item You might see NEW_ITEM-MANUFACTCODE in reports which represents manufacturerCode field in the API. |
manufacturerPartNo string |
Item’s manufacturer part number You might see NEW_ITEM-MANUFACTMAT in reports and ‘Manufacturer Part Number’ in the smartOCI user interface which represents manufacturerPartNo field in the API. |
contract string |
SRM contract to which the item refers You might see NEW_ITEM-CONTRACT in reports and ‘Contract’ in the smartOCI user interface which represents contract field in the API. |
contractItem string |
Item within the SRM contract You might see NEW_ITEM-CONTRACT_ITEM in reports and ‘Contract Line Item’ in the smartOCI user interface which represents contractItem field in the API. |
externalQuoteId string |
Number of an external bid for this item (as reference for a subsequent purchase order) You might see NEW_ITEM-EXT_QUOTE_ID in reports which represents externalQuoteId field in the API. |
externalQuoteItem string |
Item of external bid You might see NEW_ITEM-EXT_QUOTE_ITEM in reports which represents externalQuoteItem field in the API. |
category stringrequired |
SRM material group for the item You might see NEW_ITEM-MATGROUP in reports and ‘Category’ in the smartOCI user interface which represents category field in the API. |
longDescription string |
Long text for the item You might see NEW_ITEM-LONGTEXT in reports and ‘LONG DESCRIPTION’ in the smartOCI user interface which represents longDescription field in the API |
customUserAttributes [object] |
No description |
Custom User Attribute Model object |
A representation of custom user attributes. |
fieldName string |
Custom attribute name. |
fieldValue string |
Custom attribute value |
attachmentUrl string |
URL of the attachment (the attachment must be accessible for downloading under this URL) |
attachmentTitle string |
Title of the attachment (if this is empty the file name from the URL above is used) You might see NEW_ITEM-ATTACHMENT_TITLE in reports which represents attachmentTitle field in the API |
attachmentPurpose string |
Purpose of the attachment. Corresponds here to configuration. You might see NEW_ITEM-ATTACHMENT_PURPOSE in reports which represents attachmentPurpose field in the API |
externalSchemaType string |
Name of a schema via which it was imported in the SRM Server You might see NEW_ITEM-EXT_SCHEMA_TYPE in reports and ‘NEW_ITEM-EXT_SCHEMA_TYPE’ in the smartOCI user interface which represents externalSchemaType field in the API |
externalCatagoryId string |
Unique key for an external category from the schema above, independent of the version of the schema You might see NEW_ITEM-EXT_CATEGORY_ID in reports and ‘NEW_ITEM-EXT_CATEGORY_ID’ in the smartOCI user interface which represents externalCatagoryId field in the API |
externalCatagory string |
Unique key for an external category from the schema above, dependent on the version of the schema You might see NEW_ITEM-EXT_CATEGORY in reports and ‘NEW_ITEM-EXT_CATEGORY’ in the smartOCI user interface which represents externalCatagory field in the API |
sldSysName string |
Name of a system in the System Landscape Directory (SLD) You might see NEW_ITEM-SLD_SYS_NAME in reports and ‘NEW_ITEM-SLD_SYS_NAME’ in the smartOCI user interface which represents sldSysName field in the API |
quoteQuantity string |
Quantity of item in a quote You might see ITEM-QUOTE_QUANTITY in reports which represents quoteQuantity field in the API |
bundleQuantity string |
Quantity of item in a bundle BundleQuantity is required if the BundleNumber field is given. You might see ITEM-BUNDLE_QUANTITY in reports and ‘Bundle Quantity’ in the smartOCI user interface which represents bundleQuantity field in the API |
price stringrequired |
Price of item parsed according to currency code and preferred locale You might see NEW_ITEM-PRICE in reports and ‘Price’ in the smartOCI user interface which represents price field in the API. |
tieredPricing string |
Price of item in multiple tiers based upon quantity tieredPricing cannot be specified if BundleNo is given. You might see ITEM-TIERED_PRICING in reports and ‘Tiered Pricing’ in the smartOCI user interface which represents tieredPricing field in the API |
bundleNo string |
Numeric value indicating it is part of a bundle BundleNo cannot be specified if tieredPricing is given. You might see ITEM-BUNDLE_NO in reports and ‘Bundle Number’ in the smartOCI user interface which represents bundleNo field in the API |
greenItem boolean |
true or false (whether this item is environment friendly or not) You might see ITEM-GREEN_ITEM in reports which represents greenItem field in the API |
bundleName string |
It is (Read only) field |
bundleRequired boolean |
It is (Read only) field |
itemInStock string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-INSTOCK in reports which represents itemInStock field in the API. |
quantityOnHand string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-QTY_ONHAND in reports and ‘Quantity on Hand’ in the smartOCI user interface which represents quantityOnHand field in the API |
manufacturerName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MANUFACTURER_NAME in reports and ‘Manufacturer Name’ in the smartOCI user interface which represents manufacturerName field in the API |
brandName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-BRAND_NAME in reports and ‘Brand Name’ in the smartOCI user interface which represents brandName field in the API |
minOrderQuantity string |
Minimum item quantity that must be ordered If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-MIN_ORDER_QTY in reports and ‘Minimum Order Quantity’ in the smartOCI user interface which represents minOrderQuantity field in the API |
modelNo string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MODELNO in reports and ‘Model No’ in the smartOCI user interface which represents modelNo field in the API |
upc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-UPC in reports which represents upc field in the API |
caseUpc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-CASE_UPC in reports which represents caseUpc field in the API |
listPrice string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-LIST_PRICE in reports and ‘List Price’ in the smartOCI user interface which represents listPrice field in the API |
attributeModel object |
A representation of additional product attributes. |
color string |
Predefined custom field whose value can be provided in catalog file |
size string |
Predefined custom field whose value can be provided in catalog file |
gender string |
Predefined custom field whose value can be provided in catalog file |
ram string |
Predefined custom field whose value can be provided in catalog file |
cpu string |
Predefined custom field whose value can be provided in catalog file |
hdd string |
Predefined custom field whose value can be provided in catalog file |
screenSize string |
Predefined custom field whose value can be provided in catalog file |
screenResolution string |
Predefined custom field whose value can be provided in catalog file |
comments string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-COMMENTS in reports which represents comments field in the API |
energyStar boolean |
Whether this item has “energy star” attribute associated You might see ITEM-ENERGY_STAR in reports which represents energyStar field in the API |
freeShippingAvailable boolean |
Whether this item has “free shipping” attribute associated |
clearance boolean |
Whether this item has “clearance” attribute associated You might see ITEM-CLEARANCE in reports which represents clearance field in the API |
onSale boolean |
Whether this item has “on sale” attribute associated You might see ITEM-ON_SALE in reports which represents onSale field in the API |
preferred boolean |
Whether this item has “preferred” attribute associated You might see ITEM-PREFERRED in reports which represents preferred field in the API |
refurbished boolean |
Whether this item has “refurb” attribute associated You might see ITEM-REFURB in reports which represents refurbished field in the API |
contractAssoicated boolean |
Whether this item has “contract” attribute associated You might see ITEM-CONTRACT in reports which represents contractAssoicated field in the API |
rohsAssociated boolean |
Whether this item has “rohs” attribute associated You might see ITEM-ROHS in reports which represents rohsAssociated field in the API |
orderInterval string |
Interval by which quantity should be increased/decreased If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-ORDER_INTERVAL in reports and ‘Order Interval’ in the smartOCI user interface which represents orderInterval field in the API |
suppressPrice boolean |
Whether price of this item can be seen You might see ITEM-SUPPRESS_PRICE in reports and ‘Suppress Price’ in the smartOCI user interface which represents suppressPrice field in the API |
orderMultiplyQuantity string |
It is readonly field |
rating number |
Rating score of an item |
ratingCount integer |
Number of ratings for an item |
priceEditable boolean |
Is the item’s price editable You might see ITEM-PRICE_EDITABLE in reports and ‘Price Editable’ in the smartOCI user interface which represents priceEditable field in the API |
itemSuppress boolean |
Whether this item is read only and can’t be added to cart You might see ITEM-SUPPRESS in reports and ‘Item Suppress’ in the smartOCI user interface which represents itemSuppress field in the API |
externalId string |
Unique database key for this item in the catalog (Read Only) |
itemGlAccount string |
Item GL account You might see ITEM-GL_ACCOUNT in reports and ‘Item GL Account’ in the smartOCI user interface which represents itemGlAccount field in the API |
itemConfig boolean |
Whether this item should be ordered from Supplier You might see ITEM-CONFIG in reports and ‘Configurable Item’ in the smartOCI user interface which represents configurable field in the API |
itemPolicy boolean |
Whether this item represents supplier info only You might see ITEM-POLICY in reports and ‘Item Policy’ in the smartOCI user interface which represents itemPolicy field in the API |
newItemService boolean |
Flag for item service, (if true, the item will be considered SERVICE else PRODUCT) You might see NEW_ITEM-SERVICE in reports which represents newItemService field in the API |
dateCreated string(date) |
Date Catalog Item Created (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
lastUpdated string(date) |
Date Catalog Item Last Updated (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
customFields [object] |
No description |
OCI Item Custom Field object |
A representation of oci catalog item custom fields. |
customFieldId string |
Id of associated custom field |
priceAdder string |
Price Adder |
value string |
Value of the field |
fieldName string |
Friendly name of the field |
fieldType string |
Data type of the field |
active string |
Is the field active? |
displayOrder string |
Order of display |
includeInPO string |
Whether this custom field should be included in Purchase Order |
tieredPrices [object] |
No description |
Tiered Price Model object |
A representation of tiered prices |
id string |
Id associated with Tiered Price |
from string |
No description |
to string |
No description |
price string |
No description |
images [object] |
No description |
OCI Item Image object |
A representation of oci catalog images. |
fileResourceId string |
Image File Resource Id |
fileResourceBase string |
Resource Base |
fileResourceOrig string |
No description |
createdDate string(date) |
Date Catalog Item Image Created. Date should be in UTC in following format: yyyy-MM-dd. |
fieldType string |
Data type of the image |
fileName string |
Name of File |
fileTag string |
Tag of Image |
unitId string |
Resource Unit Id |
fileImagesOrig string |
Image File Origin |
Enumerated Values
| Property | Value |
|---|---|
type |
CatalogModel |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
PUBLISHED |
CatalogItemModel
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
catalogRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemNumber integer |
System generated serial number for items (Read only). |
status string |
Item’s current status (Read only). |
description stringrequired |
Description of this catalog item You might see NEW_ITEM-DESCRIPTION in reports and ‘Short Description’ in the smartOCI user interface which represents description field in the API. |
productId string |
SRM product number of the item You might see NEW_ITEM-MATNR in reports and ‘NEW_ITEM-MATNR’ in the smartOCI user interface which represents productId field in the API. |
quantity number |
Item Quantity You might see NEW_ITEM-QUANTITY in reports which represents quantity field in the API. |
uom stringrequired |
Unit of measure for items e.g., Dozen, Box etc. You might see NEW_ITEM-UNIT in reports and ‘Unit of Measure’ in the smartOCI user interface which represents uom field in the API. |
priceUnit string |
Price of an item per price unit You might see NEW_ITEM-PRICEUNIT in reports and ‘Price Unit’ in the smartOCI user interface which represents priceUnit field in the API. |
currency stringrequired |
Currency of item price. You might see NEW_ITEM-CURRENCY in reports and ‘Currency’ in the smartOCI user interface which represents currency field in the API. |
leadTime string |
Delivery time of the item in days You might see NEW_ITEM-LEADTIME in reports and ‘Lead Time’ in the smartOCI user interface which represents leadTime field in the API. |
vendorId string |
Unique Supplier ID as assigned by SmartOCI You might see NEW_ITEM-VENDOR in reports and ‘Supplier’ in the smartOCI user interface which represents vendorId field in the API. |
partNumber stringrequired |
Supplier’s product number for the item You might see NEW_ITEM-VENDORMAT in reports and ‘Vendor Part Number’ in the smartOCI user interface which represents partNumber field in the API. |
manufacturerCode string |
SRM manufacturer number of the item You might see NEW_ITEM-MANUFACTCODE in reports which represents manufacturerCode field in the API. |
manufacturerPartNo string |
Item’s manufacturer part number You might see NEW_ITEM-MANUFACTMAT in reports and ‘Manufacturer Part Number’ in the smartOCI user interface which represents manufacturerPartNo field in the API. |
contract string |
SRM contract to which the item refers You might see NEW_ITEM-CONTRACT in reports and ‘Contract’ in the smartOCI user interface which represents contract field in the API. |
contractItem string |
Item within the SRM contract You might see NEW_ITEM-CONTRACT_ITEM in reports and ‘Contract Line Item’ in the smartOCI user interface which represents contractItem field in the API. |
externalQuoteId string |
Number of an external bid for this item (as reference for a subsequent purchase order) You might see NEW_ITEM-EXT_QUOTE_ID in reports which represents externalQuoteId field in the API. |
externalQuoteItem string |
Item of external bid You might see NEW_ITEM-EXT_QUOTE_ITEM in reports which represents externalQuoteItem field in the API. |
category stringrequired |
SRM material group for the item You might see NEW_ITEM-MATGROUP in reports and ‘Category’ in the smartOCI user interface which represents category field in the API. |
longDescription string |
Long text for the item You might see NEW_ITEM-LONGTEXT in reports and ‘LONG DESCRIPTION’ in the smartOCI user interface which represents longDescription field in the API |
customUserAttributes [object] |
No description |
Custom User Attribute Model object |
A representation of custom user attributes. |
fieldName string |
Custom attribute name. |
fieldValue string |
Custom attribute value |
attachmentUrl string |
URL of the attachment (the attachment must be accessible for downloading under this URL) |
attachmentTitle string |
Title of the attachment (if this is empty the file name from the URL above is used) You might see NEW_ITEM-ATTACHMENT_TITLE in reports which represents attachmentTitle field in the API |
attachmentPurpose string |
Purpose of the attachment. Corresponds here to configuration. You might see NEW_ITEM-ATTACHMENT_PURPOSE in reports which represents attachmentPurpose field in the API |
externalSchemaType string |
Name of a schema via which it was imported in the SRM Server You might see NEW_ITEM-EXT_SCHEMA_TYPE in reports and ‘NEW_ITEM-EXT_SCHEMA_TYPE’ in the smartOCI user interface which represents externalSchemaType field in the API |
externalCatagoryId string |
Unique key for an external category from the schema above, independent of the version of the schema You might see NEW_ITEM-EXT_CATEGORY_ID in reports and ‘NEW_ITEM-EXT_CATEGORY_ID’ in the smartOCI user interface which represents externalCatagoryId field in the API |
externalCatagory string |
Unique key for an external category from the schema above, dependent on the version of the schema You might see NEW_ITEM-EXT_CATEGORY in reports and ‘NEW_ITEM-EXT_CATEGORY’ in the smartOCI user interface which represents externalCatagory field in the API |
sldSysName string |
Name of a system in the System Landscape Directory (SLD) You might see NEW_ITEM-SLD_SYS_NAME in reports and ‘NEW_ITEM-SLD_SYS_NAME’ in the smartOCI user interface which represents sldSysName field in the API |
quoteQuantity string |
Quantity of item in a quote You might see ITEM-QUOTE_QUANTITY in reports which represents quoteQuantity field in the API |
bundleQuantity string |
Quantity of item in a bundle BundleQuantity is required if the BundleNumber field is given. You might see ITEM-BUNDLE_QUANTITY in reports and ‘Bundle Quantity’ in the smartOCI user interface which represents bundleQuantity field in the API |
price stringrequired |
Price of item parsed according to currency code and preferred locale You might see NEW_ITEM-PRICE in reports and ‘Price’ in the smartOCI user interface which represents price field in the API. |
tieredPricing string |
Price of item in multiple tiers based upon quantity tieredPricing cannot be specified if BundleNo is given. You might see ITEM-TIERED_PRICING in reports and ‘Tiered Pricing’ in the smartOCI user interface which represents tieredPricing field in the API |
bundleNo string |
Numeric value indicating it is part of a bundle BundleNo cannot be specified if tieredPricing is given. You might see ITEM-BUNDLE_NO in reports and ‘Bundle Number’ in the smartOCI user interface which represents bundleNo field in the API |
greenItem boolean |
true or false (whether this item is environment friendly or not) You might see ITEM-GREEN_ITEM in reports which represents greenItem field in the API |
bundleName string |
It is (Read only) field |
bundleRequired boolean |
It is (Read only) field |
itemInStock string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-INSTOCK in reports which represents itemInStock field in the API. |
quantityOnHand string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-QTY_ONHAND in reports and ‘Quantity on Hand’ in the smartOCI user interface which represents quantityOnHand field in the API |
manufacturerName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MANUFACTURER_NAME in reports and ‘Manufacturer Name’ in the smartOCI user interface which represents manufacturerName field in the API |
brandName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-BRAND_NAME in reports and ‘Brand Name’ in the smartOCI user interface which represents brandName field in the API |
minOrderQuantity string |
Minimum item quantity that must be ordered If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-MIN_ORDER_QTY in reports and ‘Minimum Order Quantity’ in the smartOCI user interface which represents minOrderQuantity field in the API |
modelNo string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MODELNO in reports and ‘Model No’ in the smartOCI user interface which represents modelNo field in the API |
upc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-UPC in reports which represents upc field in the API |
caseUpc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-CASE_UPC in reports which represents caseUpc field in the API |
listPrice string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-LIST_PRICE in reports and ‘List Price’ in the smartOCI user interface which represents listPrice field in the API |
attributeModel object |
A representation of additional product attributes. |
color string |
Predefined custom field whose value can be provided in catalog file |
size string |
Predefined custom field whose value can be provided in catalog file |
gender string |
Predefined custom field whose value can be provided in catalog file |
ram string |
Predefined custom field whose value can be provided in catalog file |
cpu string |
Predefined custom field whose value can be provided in catalog file |
hdd string |
Predefined custom field whose value can be provided in catalog file |
screenSize string |
Predefined custom field whose value can be provided in catalog file |
screenResolution string |
Predefined custom field whose value can be provided in catalog file |
comments string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-COMMENTS in reports which represents comments field in the API |
energyStar boolean |
Whether this item has “energy star” attribute associated You might see ITEM-ENERGY_STAR in reports which represents energyStar field in the API |
freeShippingAvailable boolean |
Whether this item has “free shipping” attribute associated |
clearance boolean |
Whether this item has “clearance” attribute associated You might see ITEM-CLEARANCE in reports which represents clearance field in the API |
onSale boolean |
Whether this item has “on sale” attribute associated You might see ITEM-ON_SALE in reports which represents onSale field in the API |
preferred boolean |
Whether this item has “preferred” attribute associated You might see ITEM-PREFERRED in reports which represents preferred field in the API |
refurbished boolean |
Whether this item has “refurb” attribute associated You might see ITEM-REFURB in reports which represents refurbished field in the API |
contractAssoicated boolean |
Whether this item has “contract” attribute associated You might see ITEM-CONTRACT in reports which represents contractAssoicated field in the API |
rohsAssociated boolean |
Whether this item has “rohs” attribute associated You might see ITEM-ROHS in reports which represents rohsAssociated field in the API |
orderInterval string |
Interval by which quantity should be increased/decreased If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-ORDER_INTERVAL in reports and ‘Order Interval’ in the smartOCI user interface which represents orderInterval field in the API |
suppressPrice boolean |
Whether price of this item can be seen You might see ITEM-SUPPRESS_PRICE in reports and ‘Suppress Price’ in the smartOCI user interface which represents suppressPrice field in the API |
orderMultiplyQuantity string |
It is readonly field |
rating number |
Rating score of an item |
ratingCount integer |
Number of ratings for an item |
priceEditable boolean |
Is the item’s price editable You might see ITEM-PRICE_EDITABLE in reports and ‘Price Editable’ in the smartOCI user interface which represents priceEditable field in the API |
itemSuppress boolean |
Whether this item is read only and can’t be added to cart You might see ITEM-SUPPRESS in reports and ‘Item Suppress’ in the smartOCI user interface which represents itemSuppress field in the API |
externalId string |
Unique database key for this item in the catalog (Read Only) |
itemGlAccount string |
Item GL account You might see ITEM-GL_ACCOUNT in reports and ‘Item GL Account’ in the smartOCI user interface which represents itemGlAccount field in the API |
itemConfig boolean |
Whether this item should be ordered from Supplier You might see ITEM-CONFIG in reports and ‘Configurable Item’ in the smartOCI user interface which represents configurable field in the API |
itemPolicy boolean |
Whether this item represents supplier info only You might see ITEM-POLICY in reports and ‘Item Policy’ in the smartOCI user interface which represents itemPolicy field in the API |
newItemService boolean |
Flag for item service, (if true, the item will be considered SERVICE else PRODUCT) You might see NEW_ITEM-SERVICE in reports which represents newItemService field in the API |
dateCreated string(date) |
Date Catalog Item Created (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
lastUpdated string(date) |
Date Catalog Item Last Updated (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
customFields [object] |
No description |
OCI Item Custom Field object |
A representation of oci catalog item custom fields. |
customFieldId string |
Id of associated custom field |
priceAdder string |
Price Adder |
value string |
Value of the field |
fieldName string |
Friendly name of the field |
fieldType string |
Data type of the field |
active string |
Is the field active? |
displayOrder string |
Order of display |
includeInPO string |
Whether this custom field should be included in Purchase Order |
tieredPrices [object] |
No description |
Tiered Price Model object |
A representation of tiered prices |
id string |
Id associated with Tiered Price |
from string |
No description |
to string |
No description |
price string |
No description |
images [object] |
No description |
OCI Item Image object |
A representation of oci catalog images. |
fileResourceId string |
Image File Resource Id |
fileResourceBase string |
Resource Base |
fileResourceOrig string |
No description |
createdDate string(date) |
Date Catalog Item Image Created. Date should be in UTC in following format: yyyy-MM-dd. |
fieldType string |
Data type of the image |
fileName string |
Name of File |
fileTag string |
Tag of Image |
unitId string |
Resource Unit Id |
fileImagesOrig string |
Image File Origin |
Enumerated Values
| Property | Value |
|---|---|
type |
CatalogModel |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
PUBLISHED |
CatalogItemUploadModel
[
{
"id": "5a3bd758e61c824a33ded63a",
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CatalogModel",
"label": "Description for label",
"archived": false
},
"itemNumber": 1,
"status": "APPROVED",
"description": "Fragile, handle it with care.",
"productId": "abc",
"quantity": 12.5,
"uom": "DZN",
"priceUnit": "1",
"currency": "EUR",
"leadTime": "2",
"vendorId": "a1",
"partNumber": "BN78",
"manufacturerCode": "a1",
"manufacturerPartNo": "value",
"contract": "value",
"contractItem": "value",
"externalQuoteId": "a1",
"externalQuoteItem": "a1",
"category": "LEC01",
"longDescription": "Something really long to read ...",
"customUserAttributes": [
{
"fieldName": "Color",
"fieldValue": "Red"
}
],
"attachmentUrl": "value",
"attachmentTitle": "value",
"attachmentPurpose": "value",
"externalSchemaType": "value",
"externalCatagoryId": "value",
"externalCatagory": "value",
"sldSysName": "value",
"quoteQuantity": "value",
"bundleQuantity": "value",
"price": "value",
"tieredPricing": "value",
"bundleNo": "1",
"greenItem": false,
"bundleName": "value",
"bundleRequired": false,
"itemInStock": "value",
"quantityOnHand": "value",
"manufacturerName": "value",
"brandName": "value",
"minOrderQuantity": "value",
"modelNo": "value",
"upc": "value",
"caseUpc": "value",
"listPrice": "value",
"attributeModel": {
"color": "blue",
"size": "4x3x2",
"gender": "value",
"ram": "8GB",
"cpu": "value",
"hdd": "value",
"screenSize": "value",
"screenResolution": "value"
},
"comments": "value",
"energyStar": true,
"freeShippingAvailable": false,
"clearance": true,
"onSale": false,
"preferred": true,
"refurbished": false,
"contractAssoicated": true,
"rohsAssociated": false,
"orderInterval": "value",
"suppressPrice": false,
"orderMultiplyQuantity": "value",
"rating": 4.4,
"ratingCount": 5,
"priceEditable": true,
"itemSuppress": false,
"externalId": "Id",
"itemGlAccount": "Id",
"itemConfig": false,
"itemPolicy": false,
"newItemService": false,
"dateCreated": "2017-06-28",
"lastUpdated": "2017-06-28",
"customFields": [
{
"customFieldId": "404",
"priceAdder": "5.4",
"value": "S;M",
"fieldName": "Size",
"fieldType": "list",
"active": "true",
"displayOrder": "1",
"includeInPO": "false"
}
],
"tieredPrices": [
{
"id": "string",
"from": "string",
"to": "string",
"price": "string"
}
],
"images": [
{
"fileResourceId": "123",
"fileResourceBase": "ABC",
"fileResourceOrig": "XYZ",
"createdDate": "2017-06-28",
"fieldType": "list",
"fileName": "ABC",
"fileTag": "1",
"unitId": "1",
"fileImagesOrig": "ABC"
}
]
}
]
Properties
| Name | Description |
|---|---|
Catalog Item List [object] |
Listing of catalog items |
Catalog Item object |
A representation of Catalog Item |
id string |
System generated unique identifier for this object (Read only). |
catalogRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemNumber integer |
System generated serial number for items (Read only). |
status string |
Item’s current status (Read only). |
description stringrequired |
Description of this catalog item You might see NEW_ITEM-DESCRIPTION in reports and ‘Short Description’ in the smartOCI user interface which represents description field in the API. |
productId string |
SRM product number of the item You might see NEW_ITEM-MATNR in reports and ‘NEW_ITEM-MATNR’ in the smartOCI user interface which represents productId field in the API. |
quantity number |
Item Quantity You might see NEW_ITEM-QUANTITY in reports which represents quantity field in the API. |
uom stringrequired |
Unit of measure for items e.g., Dozen, Box etc. You might see NEW_ITEM-UNIT in reports and ‘Unit of Measure’ in the smartOCI user interface which represents uom field in the API. |
priceUnit string |
Price of an item per price unit You might see NEW_ITEM-PRICEUNIT in reports and ‘Price Unit’ in the smartOCI user interface which represents priceUnit field in the API. |
currency stringrequired |
Currency of item price. You might see NEW_ITEM-CURRENCY in reports and ‘Currency’ in the smartOCI user interface which represents currency field in the API. |
leadTime string |
Delivery time of the item in days You might see NEW_ITEM-LEADTIME in reports and ‘Lead Time’ in the smartOCI user interface which represents leadTime field in the API. |
vendorId string |
Unique Supplier ID as assigned by SmartOCI You might see NEW_ITEM-VENDOR in reports and ‘Supplier’ in the smartOCI user interface which represents vendorId field in the API. |
partNumber stringrequired |
Supplier’s product number for the item You might see NEW_ITEM-VENDORMAT in reports and ‘Vendor Part Number’ in the smartOCI user interface which represents partNumber field in the API. |
manufacturerCode string |
SRM manufacturer number of the item You might see NEW_ITEM-MANUFACTCODE in reports which represents manufacturerCode field in the API. |
manufacturerPartNo string |
Item’s manufacturer part number You might see NEW_ITEM-MANUFACTMAT in reports and ‘Manufacturer Part Number’ in the smartOCI user interface which represents manufacturerPartNo field in the API. |
contract string |
SRM contract to which the item refers You might see NEW_ITEM-CONTRACT in reports and ‘Contract’ in the smartOCI user interface which represents contract field in the API. |
contractItem string |
Item within the SRM contract You might see NEW_ITEM-CONTRACT_ITEM in reports and ‘Contract Line Item’ in the smartOCI user interface which represents contractItem field in the API. |
externalQuoteId string |
Number of an external bid for this item (as reference for a subsequent purchase order) You might see NEW_ITEM-EXT_QUOTE_ID in reports which represents externalQuoteId field in the API. |
externalQuoteItem string |
Item of external bid You might see NEW_ITEM-EXT_QUOTE_ITEM in reports which represents externalQuoteItem field in the API. |
category stringrequired |
SRM material group for the item You might see NEW_ITEM-MATGROUP in reports and ‘Category’ in the smartOCI user interface which represents category field in the API. |
longDescription string |
Long text for the item You might see NEW_ITEM-LONGTEXT in reports and ‘LONG DESCRIPTION’ in the smartOCI user interface which represents longDescription field in the API |
customUserAttributes [object] |
No description |
Custom User Attribute Model object |
A representation of custom user attributes. |
fieldName string |
Custom attribute name. |
fieldValue string |
Custom attribute value |
attachmentUrl string |
URL of the attachment (the attachment must be accessible for downloading under this URL) |
attachmentTitle string |
Title of the attachment (if this is empty the file name from the URL above is used) You might see NEW_ITEM-ATTACHMENT_TITLE in reports which represents attachmentTitle field in the API |
attachmentPurpose string |
Purpose of the attachment. Corresponds here to configuration. You might see NEW_ITEM-ATTACHMENT_PURPOSE in reports which represents attachmentPurpose field in the API |
externalSchemaType string |
Name of a schema via which it was imported in the SRM Server You might see NEW_ITEM-EXT_SCHEMA_TYPE in reports and ‘NEW_ITEM-EXT_SCHEMA_TYPE’ in the smartOCI user interface which represents externalSchemaType field in the API |
externalCatagoryId string |
Unique key for an external category from the schema above, independent of the version of the schema You might see NEW_ITEM-EXT_CATEGORY_ID in reports and ‘NEW_ITEM-EXT_CATEGORY_ID’ in the smartOCI user interface which represents externalCatagoryId field in the API |
externalCatagory string |
Unique key for an external category from the schema above, dependent on the version of the schema You might see NEW_ITEM-EXT_CATEGORY in reports and ‘NEW_ITEM-EXT_CATEGORY’ in the smartOCI user interface which represents externalCatagory field in the API |
sldSysName string |
Name of a system in the System Landscape Directory (SLD) You might see NEW_ITEM-SLD_SYS_NAME in reports and ‘NEW_ITEM-SLD_SYS_NAME’ in the smartOCI user interface which represents sldSysName field in the API |
quoteQuantity string |
Quantity of item in a quote You might see ITEM-QUOTE_QUANTITY in reports which represents quoteQuantity field in the API |
bundleQuantity string |
Quantity of item in a bundle BundleQuantity is required if the BundleNumber field is given. You might see ITEM-BUNDLE_QUANTITY in reports and ‘Bundle Quantity’ in the smartOCI user interface which represents bundleQuantity field in the API |
price stringrequired |
Price of item parsed according to currency code and preferred locale You might see NEW_ITEM-PRICE in reports and ‘Price’ in the smartOCI user interface which represents price field in the API. |
tieredPricing string |
Price of item in multiple tiers based upon quantity tieredPricing cannot be specified if BundleNo is given. You might see ITEM-TIERED_PRICING in reports and ‘Tiered Pricing’ in the smartOCI user interface which represents tieredPricing field in the API |
bundleNo string |
Numeric value indicating it is part of a bundle BundleNo cannot be specified if tieredPricing is given. You might see ITEM-BUNDLE_NO in reports and ‘Bundle Number’ in the smartOCI user interface which represents bundleNo field in the API |
greenItem boolean |
true or false (whether this item is environment friendly or not) You might see ITEM-GREEN_ITEM in reports which represents greenItem field in the API |
bundleName string |
It is (Read only) field |
bundleRequired boolean |
It is (Read only) field |
itemInStock string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-INSTOCK in reports which represents itemInStock field in the API. |
quantityOnHand string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-QTY_ONHAND in reports and ‘Quantity on Hand’ in the smartOCI user interface which represents quantityOnHand field in the API |
manufacturerName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MANUFACTURER_NAME in reports and ‘Manufacturer Name’ in the smartOCI user interface which represents manufacturerName field in the API |
brandName string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-BRAND_NAME in reports and ‘Brand Name’ in the smartOCI user interface which represents brandName field in the API |
minOrderQuantity string |
Minimum item quantity that must be ordered If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-MIN_ORDER_QTY in reports and ‘Minimum Order Quantity’ in the smartOCI user interface which represents minOrderQuantity field in the API |
modelNo string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-MODELNO in reports and ‘Model No’ in the smartOCI user interface which represents modelNo field in the API |
upc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-UPC in reports which represents upc field in the API |
caseUpc string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-CASE_UPC in reports which represents caseUpc field in the API |
listPrice string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-LIST_PRICE in reports and ‘List Price’ in the smartOCI user interface which represents listPrice field in the API |
attributeModel object |
A representation of additional product attributes. |
color string |
Predefined custom field whose value can be provided in catalog file |
size string |
Predefined custom field whose value can be provided in catalog file |
gender string |
Predefined custom field whose value can be provided in catalog file |
ram string |
Predefined custom field whose value can be provided in catalog file |
cpu string |
Predefined custom field whose value can be provided in catalog file |
hdd string |
Predefined custom field whose value can be provided in catalog file |
screenSize string |
Predefined custom field whose value can be provided in catalog file |
screenResolution string |
Predefined custom field whose value can be provided in catalog file |
comments string |
Predefined custom field whose value can be provided in catalog file You might see ITEM-COMMENTS in reports which represents comments field in the API |
energyStar boolean |
Whether this item has “energy star” attribute associated You might see ITEM-ENERGY_STAR in reports which represents energyStar field in the API |
freeShippingAvailable boolean |
Whether this item has “free shipping” attribute associated |
clearance boolean |
Whether this item has “clearance” attribute associated You might see ITEM-CLEARANCE in reports which represents clearance field in the API |
onSale boolean |
Whether this item has “on sale” attribute associated You might see ITEM-ON_SALE in reports which represents onSale field in the API |
preferred boolean |
Whether this item has “preferred” attribute associated You might see ITEM-PREFERRED in reports which represents preferred field in the API |
refurbished boolean |
Whether this item has “refurb” attribute associated You might see ITEM-REFURB in reports which represents refurbished field in the API |
contractAssoicated boolean |
Whether this item has “contract” attribute associated You might see ITEM-CONTRACT in reports which represents contractAssoicated field in the API |
rohsAssociated boolean |
Whether this item has “rohs” attribute associated You might see ITEM-ROHS in reports which represents rohsAssociated field in the API |
orderInterval string |
Interval by which quantity should be increased/decreased If both orderInterval and minOrderQuantity are provided then they must be equal. You might see ITEM-ORDER_INTERVAL in reports and ‘Order Interval’ in the smartOCI user interface which represents orderInterval field in the API |
suppressPrice boolean |
Whether price of this item can be seen You might see ITEM-SUPPRESS_PRICE in reports and ‘Suppress Price’ in the smartOCI user interface which represents suppressPrice field in the API |
orderMultiplyQuantity string |
It is readonly field |
rating number |
Rating score of an item |
ratingCount integer |
Number of ratings for an item |
priceEditable boolean |
Is the item’s price editable You might see ITEM-PRICE_EDITABLE in reports and ‘Price Editable’ in the smartOCI user interface which represents priceEditable field in the API |
itemSuppress boolean |
Whether this item is read only and can’t be added to cart You might see ITEM-SUPPRESS in reports and ‘Item Suppress’ in the smartOCI user interface which represents itemSuppress field in the API |
externalId string |
Unique database key for this item in the catalog (Read Only) |
itemGlAccount string |
Item GL account You might see ITEM-GL_ACCOUNT in reports and ‘Item GL Account’ in the smartOCI user interface which represents itemGlAccount field in the API |
itemConfig boolean |
Whether this item should be ordered from Supplier You might see ITEM-CONFIG in reports and ‘Configurable Item’ in the smartOCI user interface which represents configurable field in the API |
itemPolicy boolean |
Whether this item represents supplier info only You might see ITEM-POLICY in reports and ‘Item Policy’ in the smartOCI user interface which represents itemPolicy field in the API |
newItemService boolean |
Flag for item service, (if true, the item will be considered SERVICE else PRODUCT) You might see NEW_ITEM-SERVICE in reports which represents newItemService field in the API |
dateCreated string(date) |
Date Catalog Item Created (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
lastUpdated string(date) |
Date Catalog Item Last Updated (Read Only). Date should be in UTC in following format: yyyy-MM-dd. |
customFields [object] |
No description |
OCI Item Custom Field object |
A representation of oci catalog item custom fields. |
customFieldId string |
Id of associated custom field |
priceAdder string |
Price Adder |
value string |
Value of the field |
fieldName string |
Friendly name of the field |
fieldType string |
Data type of the field |
active string |
Is the field active? |
displayOrder string |
Order of display |
includeInPO string |
Whether this custom field should be included in Purchase Order |
tieredPrices [object] |
No description |
Tiered Price Model object |
A representation of tiered prices |
id string |
Id associated with Tiered Price |
from string |
No description |
to string |
No description |
price string |
No description |
images [object] |
No description |
OCI Item Image object |
A representation of oci catalog images. |
fileResourceId string |
Image File Resource Id |
fileResourceBase string |
Resource Base |
fileResourceOrig string |
No description |
createdDate string(date) |
Date Catalog Item Image Created. Date should be in UTC in following format: yyyy-MM-dd. |
fieldType string |
Data type of the image |
fileName string |
Name of File |
fileTag string |
Tag of Image |
unitId string |
Resource Unit Id |
fileImagesOrig string |
Image File Origin |
Enumerated Values
| Property | Value |
|---|---|
type |
CatalogModel |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
PUBLISHED |
CatalogListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of catalogs. |
Catalog object |
A representation of Catalog |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Catalog’s name. |
catalogType string |
Catalog’s type |
editOption string |
Edit option of the catalog. In the context of the catalog API POST/PUT requests, only “MERGE” and “REPLACE” are accepted as valid values. While there may be additional values stored in existing catalogs, which will be exposed in the GET catalog APIs. It’s important to note that these additional values are not supported when creating or updating catalogs through the API. |
versionNumber integer |
version number of the catalog (Read only). |
description string |
Description of this catalog |
language string |
Language of this catalog. This field is read only. |
supplierRefs [object] |
No description |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
contentViewRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customFieldRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approverRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
docNo any |
No description |
continued
| Name | Description |
|---|---|
submitterRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
docNo any |
No description |
continued
| Name | Description |
|---|---|
quantityLocked boolean |
Correspond to “Fixed Order Quantity” checkbox on Catalog Modal. |
transferItemDescription boolean |
To control whether the LongItemDescription should be displayed based on its boolean value in the catalog flag. |
searchAllowed boolean |
Correspond to “Search Allowed” checkbox for External Catalog Definition. |
active boolean |
This flag indicates whether or not this catalog is available for use. Active true means its available, otherwise not. This field is read only. |
validFrom string(date) |
Catalog Start Date for automatic publishing. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Catalog End Date for automatic expiry. Date should be in UTC in following format: yyyy-MM-dd. |
timeZone string |
Time zone info for the catalog. |
contractNumber string |
Correspond to ‘Contract Number’ Additional field on Catalog Modal |
contractLineItem string |
Correspond to ‘Contract Line Item’ Additional field on Catalog Modal |
approvedItemsCount integer |
Number of items which are approved by the approver (Read only). |
rejectedItemsCount integer |
Number of items which are rejected by the approver (Read only). |
pendingItemsCount integer |
Number of items which are pending approval (Read only). |
publishedItemsCount integer |
Number of items which are published (Read only). |
inputRecordsCount integer |
Number of records parsed from uploaded catalog file (Read only). |
outputRecordsCount integer |
Number of records successfully saved in database (Read only). |
failedRecordsCount integer |
Number of records that couldn’t be saved (Read only). |
clientCatalogId string |
Additional field in catalog model |
externalCatologDefinition object |
A collection of fields to represent external definitions for the catalog |
punchOutMethod string |
Type of punchout method |
customImageField string |
Image field |
communicationType string |
Communication types available |
encodingType string |
Correspond to ‘Contract Line Item’ Additional field on Catalog Modal |
extrinsicFields [object] |
No description |
Extrinsic Fields in Catalog Definition object |
A collection of exrinsic fields |
sequence integer |
Order of appearance |
name string |
Field Name |
value string |
Field Value |
catalogStatus string |
Catalog’s status. This field is read only. |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
catalogType |
EXTERNAL |
catalogType |
INTERNAL |
editOption |
MERGE |
editOption |
REPLACE |
type |
SupplierModel |
type |
ContentViewModel |
type |
CustomFieldsModel |
type |
UserModel |
type |
UserModel |
punchOutMethod |
GET |
punchOutMethod |
POST |
catalogStatus |
PUBLISHED |
CatalogModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "C-100",
"name": "Summer'18 Catalog",
"catalogType": "INTERNAL",
"editOption": "MERGE",
"versionNumber": 2,
"description": "Purpose of this catalog is to ... ",
"language": "en",
"supplierRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
],
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"customFieldRefs": [
{
"type": "CustomFieldsModel"
}
],
"approverRefs": [
{
"type": "UserModel",
"docNo": "notifyvroozi@gmail.com"
}
],
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "notifyvroozi@gmail.com",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"quantityLocked": true,
"transferItemDescription": true,
"searchAllowed": true,
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"timeZone": "-12:00",
"contractNumber": "X10",
"contractLineItem": "xyz",
"approvedItemsCount": 100,
"rejectedItemsCount": 10,
"pendingItemsCount": 237,
"publishedItemsCount": 505,
"inputRecordsCount": 850,
"outputRecordsCount": 200,
"failedRecordsCount": 55,
"clientCatalogId": "ext-catalog",
"externalCatologDefinition": {
"punchOutMethod": "POST",
"customImageField": "xyz",
"communicationType": "xyz",
"encodingType": "xyz",
"extrinsicFields": [
{
"sequence": 1,
"name": "customField1",
"value": "xyz"
}
]
},
"catalogStatus": "PUBLISHED",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Catalog’s name. |
catalogType string |
Catalog’s type |
editOption string |
Edit option of the catalog. In the context of the catalog API POST/PUT requests, only “MERGE” and “REPLACE” are accepted as valid values. While there may be additional values stored in existing catalogs, which will be exposed in the GET catalog APIs. It’s important to note that these additional values are not supported when creating or updating catalogs through the API. |
versionNumber integer |
version number of the catalog (Read only). |
description string |
Description of this catalog |
language string |
Language of this catalog. This field is read only. |
supplierRefs [object] |
No description |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
contentViewRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customFieldRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approverRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
docNo any |
No description |
continued
| Name | Description |
|---|---|
submitterRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
docNo any |
No description |
continued
| Name | Description |
|---|---|
quantityLocked boolean |
Correspond to “Fixed Order Quantity” checkbox on Catalog Modal. |
transferItemDescription boolean |
To control whether the LongItemDescription should be displayed based on its boolean value in the catalog flag. |
searchAllowed boolean |
Correspond to “Search Allowed” checkbox for External Catalog Definition. |
active boolean |
This flag indicates whether or not this catalog is available for use. Active true means its available, otherwise not. This field is read only. |
validFrom string(date) |
Catalog Start Date for automatic publishing. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Catalog End Date for automatic expiry. Date should be in UTC in following format: yyyy-MM-dd. |
timeZone string |
Time zone info for the catalog. |
contractNumber string |
Correspond to ‘Contract Number’ Additional field on Catalog Modal |
contractLineItem string |
Correspond to ‘Contract Line Item’ Additional field on Catalog Modal |
approvedItemsCount integer |
Number of items which are approved by the approver (Read only). |
rejectedItemsCount integer |
Number of items which are rejected by the approver (Read only). |
pendingItemsCount integer |
Number of items which are pending approval (Read only). |
publishedItemsCount integer |
Number of items which are published (Read only). |
inputRecordsCount integer |
Number of records parsed from uploaded catalog file (Read only). |
outputRecordsCount integer |
Number of records successfully saved in database (Read only). |
failedRecordsCount integer |
Number of records that couldn’t be saved (Read only). |
clientCatalogId string |
Additional field in catalog model |
externalCatologDefinition object |
A collection of fields to represent external definitions for the catalog |
punchOutMethod string |
Type of punchout method |
customImageField string |
Image field |
communicationType string |
Communication types available |
encodingType string |
Correspond to ‘Contract Line Item’ Additional field on Catalog Modal |
extrinsicFields [object] |
No description |
Extrinsic Fields in Catalog Definition object |
A collection of exrinsic fields |
sequence integer |
Order of appearance |
name string |
Field Name |
value string |
Field Value |
catalogStatus string |
Catalog’s status. This field is read only. |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
catalogType |
EXTERNAL |
catalogType |
INTERNAL |
editOption |
MERGE |
editOption |
REPLACE |
type |
SupplierModel |
type |
ContentViewModel |
type |
CustomFieldsModel |
type |
UserModel |
type |
UserModel |
punchOutMethod |
GET |
punchOutMethod |
POST |
catalogStatus |
PUBLISHED |
CatalogStatusUpdateModel
{
"comments": "Rejecting catalog",
"action": "APPROVE",
"submitterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Properties
| Name | Description |
|---|---|
comments string |
Catalog status |
action stringrequired |
In case of ACTIVATE or DEACTIVATE action, the catalog’s status is not changed, only the ‘active’ flag of catalog is updated to either ‘true’ or ‘false’. For all other actions, catalog status is updated. |
submitterRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
action |
APPROVE |
action |
ACTIVATE |
action |
PUBLISH |
action |
DISAPPROVE |
action |
DEACTIVATE |
action |
REJECT |
action |
UNPUBLISH |
type |
UserModel |
ClassListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of classes. |
Class object |
A representation of the Class |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this class for business use. |
name stringrequired |
Name of this class |
description string |
Description for this class. |
companyCodeRefs [allOf] |
List of Company Code Reference. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
enableForAllCompanyCodes boolean |
To indicate whether or not this Class would apply to all Company Codes. Default: false |
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestors [allOf] |
List of Ancestor Classes. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
validFrom string(date) |
Date from when this class will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this class will be available. Date should be in UTC in following format: yyyy-MM-dd. |
active boolean |
To indicate whether or not this class is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
ClassModel |
type |
ClassModel |
ClassModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11.",
"name": "Class-123.",
"description": "Class 11",
"companyCodeRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
}
],
"enableForAllCompanyCodes": true,
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
}
],
"validFrom": "2025-06-28",
"validTo": "2030-06-28",
"active": true,
"dateCreated": "2025-03-15T13:56:04.037+0000",
"lastUpdated": "2015-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this class for business use. |
name stringrequired |
Name of this class |
description string |
Description for this class. |
companyCodeRefs [allOf] |
List of Company Code Reference. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
enableForAllCompanyCodes boolean |
To indicate whether or not this Class would apply to all Company Codes. Default: false |
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestors [allOf] |
List of Ancestor Classes. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
validFrom string(date) |
Date from when this class will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this class will be available. Date should be in UTC in following format: yyyy-MM-dd. |
active boolean |
To indicate whether or not this class is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
ClassModel |
type |
ClassModel |
CompanyCodeListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
No description |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this plant code for business use. |
description stringrequired |
Description for this company code. |
companyAddressRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
billingAddressRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approvalGroupRequired boolean |
Approval Group Required flag |
locationTypeRequired boolean |
Location Type Required flag |
active boolean |
If true, this company code will be available for use, otherwise, it will be inactive |
currencies [string] |
List of currencies that are available for this company code |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
AddressModel |
type |
AddressModel |
currencies |
USD |
currencies |
CAD |
currencies |
AUD |
currencies |
EUR |
currencies |
JPY |
currencies |
SEK |
CompanyCodeModel
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "DCC01",
"description": "Default Company Code 01",
"companyAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"billingAddressRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AddressModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRequired": false,
"locationTypeRequired": false,
"active": true,
"currencies": [
"USD",
"MXN"
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this plant code for business use. |
description stringrequired |
Description for this company code. |
companyAddressRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
billingAddressRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approvalGroupRequired boolean |
Approval Group Required flag |
locationTypeRequired boolean |
Location Type Required flag |
active boolean |
If true, this company code will be available for use, otherwise, it will be inactive |
currencies [string] |
List of currencies that are available for this company code |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
AddressModel |
type |
AddressModel |
currencies |
USD |
currencies |
CAD |
currencies |
AUD |
currencies |
EUR |
currencies |
JPY |
currencies |
SEK |
ContentGroupModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
token string |
Code for business use (Read only). |
name stringrequired |
Content Group name |
contentViewRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this content group is active in the system. true means active and false means inactive. Default: true |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
ContentViewModel |
ContentGroupModelList
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"token": "C000101",
"name": "content-group 1101001",
"contentViewRefs": [
{
"type": "ContentViewModel"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of content groups. |
ContentGroupModel object |
A representation of the Content Group |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
token string |
Code for business use (Read only). |
name stringrequired |
Content Group name |
contentViewRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this content group is active in the system. true means active and false means inactive. Default: true |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
ContentViewModel |
ContentViewModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Content View name |
description string |
Description of the content view. |
active boolean |
To indicate whether or not this content view is active in the system. true means active and false means inactive. Default: true |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
ContentViewModelList
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"name": "content-view-01",
"description": "Content view is used for internal catalogs",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of content views. |
ContentViewModel object |
A representation of the Content View |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Content View name |
description string |
Description of the content view. |
active boolean |
To indicate whether or not this content view is active in the system. true means active and false means inactive. Default: true |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
CostCenterListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of cost centers. |
Cost Center object |
A representation of the Cost Center |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this cost center for business use. |
description stringrequired |
Description for this cost center. |
profitCenter string |
Name of the profit center for this cost center. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this cost center is active in the system. true means active and false means inactive. Default: false |
validFrom string(date) |
Date from when this cost center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this cost center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestorsRef [allOf] |
List of Ancestors. It is readonly field |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
type |
CostCenterModel |
type |
CostCenterModel |
CostCenterModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Cost Center 11",
"profitCenter": "PFT Center",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"ancestorsRef": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this cost center for business use. |
description stringrequired |
Description for this cost center. |
profitCenter string |
Name of the profit center for this cost center. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this cost center is active in the system. true means active and false means inactive. Default: false |
validFrom string(date) |
Date from when this cost center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this cost center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestorsRef [allOf] |
List of Ancestors. It is readonly field |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
type |
CostCenterModel |
type |
CostCenterModel |
CustomerAccountingReferenceListModel
[
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
Properties
| Name | Description |
|---|---|
Customer Accounting Referenece List [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this customer accounting reference is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
ProjectModel |
type |
UserModel |
CustomerListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Customer objects |
Customer object |
A representation of the Customer |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Customer code for business use. |
name stringrequired |
Customer name |
accountingRefs [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this customer accounting reference is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
active boolean |
To indicate whether or not this customer is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
ProjectModel |
type |
UserModel |
CustomerModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "C000101",
"name": "Customer 1101001",
"accountingRefs": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
],
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000."
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Customer code for business use. |
name stringrequired |
Customer name |
accountingRefs [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this customer accounting reference is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
active boolean |
To indicate whether or not this customer is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
ProjectModel |
type |
UserModel |
ErrorDataModel
{
"id": "34ed4-edcd-3456abed-edcb234-2c2d",
"status": "400",
"title": "Bad Request",
"timestamp": "2019-04-30T13:56:04.037+0000",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this error object. |
status string |
Error status |
title string |
Error title |
timestamp string(date-time) |
Instant when the error occurs. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
errors [object] |
List of errors found in the request. |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
EventModel
{
"timestamp": "2019-08-24T14:15:22Z",
"documentType": "PURCHASE_REQUEST",
"eventSource": "VROOZI_API",
"eventType": "PENDING",
"id": "" ,
"payloadRef": {
"batchId": "string",
"code": "string",
"docNo": "string",
"externalId": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z"
},
"status": "NEW"
}
Properties
| Name | Description |
|---|---|
timestamp string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
documentType string |
Enumerble document types |
eventSource string |
Source of the event from which it originates |
eventType string |
Type of document status. |
id string |
System generated unique identifier for this object |
payloadRef |
No description |
status string |
List of status |
Enumerated Values
| Property | Value |
|---|---|
documentType |
PURCHASE_REQUEST |
documentType |
PURCHASE_ORDER |
documentType |
GOODS_RECEIPT |
documentType |
GOODS_RETURN |
documentType |
INVOICE |
documentType |
MEMO |
eventSource |
VROOZI_API |
eventSource |
PMAN |
eventSource |
SMARTOCI |
eventSource |
EXTERNAL_SYSTEM |
eventSource |
SYSTEM |
eventType |
PENDING |
eventType |
PROCESSING |
eventType |
APPROVED |
eventType |
ORDERED |
eventType |
POSTING |
eventType |
POSTED |
eventType |
CONFIRMED |
eventType |
SUBMITTED |
status |
NEW |
status |
PROCESSED |
status |
ERROR |
EventReference
{
"batchId": "string",
"code": "string",
"docNo": "string",
"externalId": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z"
}
Properties
| Name | Description |
|---|---|
batchId string |
Batch id |
code string |
Code |
docNo string |
Document number |
externalId string |
Unique identifier for external system |
id string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
ExternalAccountingStringsValidationModel
{
"requestId": "5be06b3f-33f4-4a9b-bf32-4e97992ae7e0",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"validationDetails": [
{
"entryNumber": 1,
"itemRefs": [
{
"itemId": "15440",
"lineNumber": "00001"
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"amount": 100,
"currency": "USD",
"retult": null,
"accountingElements": {
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
}
]
}
Properties
| Name | Description |
|---|---|
requestId string |
Request Id |
documentRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
validationDetails [object]required |
Validation Details |
entryNumber integer |
Entry Number description |
itemRefs [object] |
list of items references |
itemId string |
Item Id description |
lineNumber string |
Item Id description |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
amount integer |
Amount |
currency string |
Currency code |
retult object |
Result |
accountingElements object |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseRequestModel |
type |
PurchaseOrderModel |
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
ProjectModel |
type |
ClassModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
CompanyCodeModel |
type |
PlantCodeModel |
type |
PurchasingOrganizationModel |
GLAccountListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of gl accounts. |
GL Account object |
A representation of the GL Account |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this glAccount for business use. |
description stringrequired |
Description for this glAccount. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this glAccount is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
GLAccountModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL01",
"description": "GL Account 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
}
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this glAccount for business use. |
description stringrequired |
Description for this glAccount. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this glAccount is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
GenericErrorModel
{
"message": "Unauthorized"
}
Properties
| Name | Description |
|---|---|
message string |
Generic error message |
GenericReferenceDataModel
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
Properties
| Name | Description |
|---|---|
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
GoodsReceiptListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of goods receipt. |
Goods Receipt object |
A representation of Goods Receipt |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
receiptNumber string |
GoodsReceipt’s Receipt Number (Read only). |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
GoodsReceipt’s rmaNumber. |
finalReceipt boolean |
When true, closes PO for receiving after confirming this GR. Effective only when GR is partially confirmed. In case of full reception, this flag is ignored. |
billOfLading string |
GoodsReceipt’s bill of lading. |
packingSlip string |
GoodsReceipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
comments string |
Comments. |
postingDate string(date-time)required |
Posting Date of the Goods receipt document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
currency string |
GoodsReceipt’s currency (Read only). |
totalAmount number |
Total Amount |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber integer |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Receipt’s description |
receiveBy string |
Goods Receipt Item’s received type e.g. receive by Quantity or Value. Receive by Value is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Receipt’s Quantity Ordered (Read only). |
quantityReceived number |
Goods Receipt’s Quantity Received. |
quantityOutstanding number |
Goods Receipt’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Receipt’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueReceived number |
Goods Receipt Item’s Amount Received. |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
uom string |
Goods Receipt’s unit of measure (Read only). |
unitPrice number |
Goods Receipt’s unit price (Read only). |
priceUnit integer |
Goods Receipt’s price unit (Read only). |
totalPrice number |
Goods Receipt’s total price (Read only). |
deliveryDate string(date-time) |
Delivery Date of Goods Receipt (Read only). |
manufacturerName string |
Goods Receipt’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Receipt’s manufacturer part no (Read only). |
partNo string |
Goods Receipt’s Part No (Read only). |
longDescription string |
Goods Receipt’s long description (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Receipt |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Receipt |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Receipt |
cancelable boolean |
Identifies if item is cancelable based on the criteria that no Goods Return or Invoice is created in pending or higher state against this item. |
canceled boolean |
Identifies if item within a Goods Receipt is Canceled. |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseRequestModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
DRAFT |
status |
CONFIRMED |
status |
CANCELED |
type |
UserModel |
type |
SupplierModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
GoodsReceiptModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
receiptNumber string |
GoodsReceipt’s Receipt Number (Read only). |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
GoodsReceipt’s rmaNumber. |
finalReceipt boolean |
When true, closes PO for receiving after confirming this GR. Effective only when GR is partially confirmed. In case of full reception, this flag is ignored. |
billOfLading string |
GoodsReceipt’s bill of lading. |
packingSlip string |
GoodsReceipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
comments string |
Comments. |
postingDate string(date-time)required |
Posting Date of the Goods receipt document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
currency string |
GoodsReceipt’s currency (Read only). |
totalAmount number |
Total Amount |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber integer |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Receipt’s description |
receiveBy string |
Goods Receipt Item’s received type e.g. receive by Quantity or Value. Receive by Value is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Receipt’s Quantity Ordered (Read only). |
quantityReceived number |
Goods Receipt’s Quantity Received. |
quantityOutstanding number |
Goods Receipt’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Receipt’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueReceived number |
Goods Receipt Item’s Amount Received. |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
uom string |
Goods Receipt’s unit of measure (Read only). |
unitPrice number |
Goods Receipt’s unit price (Read only). |
priceUnit integer |
Goods Receipt’s price unit (Read only). |
totalPrice number |
Goods Receipt’s total price (Read only). |
deliveryDate string(date-time) |
Delivery Date of Goods Receipt (Read only). |
manufacturerName string |
Goods Receipt’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Receipt’s manufacturer part no (Read only). |
partNo string |
Goods Receipt’s Part No (Read only). |
longDescription string |
Goods Receipt’s long description (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Receipt |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Receipt |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Receipt |
cancelable boolean |
Identifies if item is cancelable based on the criteria that no Goods Return or Invoice is created in pending or higher state against this item. |
canceled boolean |
Identifies if item within a Goods Receipt is Canceled. |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseRequestModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
DRAFT |
status |
CONFIRMED |
status |
CANCELED |
type |
UserModel |
type |
SupplierModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
GoodsReturnListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of goods return. |
Goods Return object |
A representation of Goods Return |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
returnNumber string |
Goods Receipt’s Return Number (Read only). |
goodsReceiptRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
postingDate string(date-time)required |
Posting Date of the Goods return document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
Goods Receipt’s rmaNumber. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
billOfLading string |
Goods Receipt’s bill of lading. |
packingSlip string |
Goods Receipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
comments string |
Comments. |
currency string |
Goods Receipt’s currency (Read only). |
totalAmount number |
Total Amount |
receiptCancelation boolean |
Identifies if Goods Return documen is created on the basis of Goods Receipt cancelation. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber numberrequired |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Return’s description |
receiveBy string |
Goods Return Item’s returned type. Receive by ITEM_VALUE is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Return’s Quantity Ordered (Read only). |
quantityReturned number |
Goods Return’s Quantity Returned. |
quantityOutstanding number |
Goods Return’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Return’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
valueReturned number |
Goods Return’s Amount Returned. |
uom string |
Goods Return’s unit of measure (Read only). |
unitPrice number |
Goods Return’s unit price (Read only). |
priceUnit integer |
Goods Return’s price unit (Read only). |
totalPrice number |
Goods Return’s total price (Read only). |
manufacturerName string |
Goods Return’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Return’s manufacturer part no (Read only). |
partNo string |
Goods Return’s Part No (Read only). |
longDescription string |
Goods Return’s long description (Read only). |
returnReasonCode string |
Goods Return reason code. The default value is 103 which represents that the item is No Longer NeededPossible values with description are: 101 Defective102 Quality Unacceptable103 No Longer Needed104 Received Late105 Goods Damaged106 Wrong Address107 Wrong Item Sent108 Received in Error |
deliveryDate string(date-time) |
Delivery Date of Goods Return (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Return |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Return |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Return |
Enumerated Values
| Property | Value |
|---|---|
type |
GoodsReceiptModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
UserModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
SupplierModel |
status |
DRAFT |
status |
CONFIRMED |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
returnReasonCode |
101 |
returnReasonCode |
102 |
returnReasonCode |
103 |
returnReasonCode |
104 |
returnReasonCode |
105 |
returnReasonCode |
106 |
returnReasonCode |
107 |
returnReasonCode |
108 |
GoodsReturnModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
returnNumber string |
Goods Receipt’s Return Number (Read only). |
goodsReceiptRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
postingDate string(date-time)required |
Posting Date of the Goods return document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
Goods Receipt’s rmaNumber. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
billOfLading string |
Goods Receipt’s bill of lading. |
packingSlip string |
Goods Receipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
comments string |
Comments. |
currency string |
Goods Receipt’s currency (Read only). |
totalAmount number |
Total Amount |
receiptCancelation boolean |
Identifies if Goods Return documen is created on the basis of Goods Receipt cancelation. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber numberrequired |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Return’s description |
receiveBy string |
Goods Return Item’s returned type. Receive by ITEM_VALUE is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Return’s Quantity Ordered (Read only). |
quantityReturned number |
Goods Return’s Quantity Returned. |
quantityOutstanding number |
Goods Return’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Return’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
valueReturned number |
Goods Return’s Amount Returned. |
uom string |
Goods Return’s unit of measure (Read only). |
unitPrice number |
Goods Return’s unit price (Read only). |
priceUnit integer |
Goods Return’s price unit (Read only). |
totalPrice number |
Goods Return’s total price (Read only). |
manufacturerName string |
Goods Return’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Return’s manufacturer part no (Read only). |
partNo string |
Goods Return’s Part No (Read only). |
longDescription string |
Goods Return’s long description (Read only). |
returnReasonCode string |
Goods Return reason code. The default value is 103 which represents that the item is No Longer NeededPossible values with description are: 101 Defective102 Quality Unacceptable103 No Longer Needed104 Received Late105 Goods Damaged106 Wrong Address107 Wrong Item Sent108 Received in Error |
deliveryDate string(date-time) |
Delivery Date of Goods Return (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Return |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Return |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Return |
Enumerated Values
| Property | Value |
|---|---|
type |
GoodsReceiptModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
UserModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
SupplierModel |
status |
DRAFT |
status |
CONFIRMED |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
returnReasonCode |
101 |
returnReasonCode |
102 |
returnReasonCode |
103 |
returnReasonCode |
104 |
returnReasonCode |
105 |
returnReasonCode |
106 |
returnReasonCode |
107 |
returnReasonCode |
108 |
InternalOrderListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Internal Orders. |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
orderNumber stringrequired |
Internal Order Number |
description stringrequired |
Description for this internal order |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
profitCenter string |
Profit center for internal order |
active boolean |
This flag indicates whether or not this plant code is available for use. Active true means its available, otherwise not. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
type |
CompanyCodeModel |
InternalOrderModel
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"orderNumber": "1234",
"description": "sample description",
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"profitCenter": "sample profit center",
"active": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
orderNumber stringrequired |
Internal Order Number |
description stringrequired |
Description for this internal order |
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
profitCenter string |
Profit center for internal order |
active boolean |
This flag indicates whether or not this plant code is available for use. Active true means its available, otherwise not. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
type |
CompanyCodeModel |
InvoiceBulkStatusUpdateRequestModel
{
"statusUpdateModels": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
]
}
Properties
| Name | Description |
|---|---|
statusUpdateModels [object]required |
List Of Invoice Status Update Model |
id string |
Internal Mongo ID |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Document |
autoRepost boolean |
Setting this flag true will move POSTING_FAILED invoice into POSTING status. |
comments string |
Comments |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING_FAILED |
status |
POSTED |
InvoiceBulkStatusUpdateResponseModel
{
"success": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
],
"failed": [
{
"data": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
}
],
"totalSuccess": 1,
"totalFailed": 1
}
Properties
| Name | Description |
|---|---|
success [object] |
List of invoices whose status updated successfully. |
id string |
Internal Mongo ID |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Document |
autoRepost boolean |
Setting this flag true will move POSTING_FAILED invoice into POSTING status. |
comments string |
Comments |
failed [object] |
List of failures invoices whose status updating failed. |
Invoice Bulk Status Update Model Response object |
A Invoice Bulk Status Update Model Response |
data object |
Object to update invoice status |
id string |
Internal Mongo ID |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Document |
autoRepost boolean |
Setting this flag true will move POSTING_FAILED invoice into POSTING status. |
comments string |
Comments |
errors [object] |
List Of failures invoices whose status updating failed. |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
totalSuccess number |
Total number of Invoice status updated successfully. |
totalFailed number |
Total number of Invoice status updation failed. |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING_FAILED |
status |
POSTED |
status |
POSTING_FAILED |
status |
POSTED |
InvoiceListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of invoices. |
Invoice object |
A representation of invoice data model |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
invoiceNumber string |
System generated unique number (Read only). |
referenceDocNumber string |
Reference DocNumber |
type string |
Type |
status string |
Status of the invoice |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
postingDate string(date-time) |
Posting Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
invoiceDate string(date-time) |
Invoice Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
clearingDate string(date-time) |
Clearing Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
baselineDate string(date-time) |
Baseline Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
parkedDate string(date-time) |
Parked Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentDate string(date-time) |
Payment Date |
paymentDueDate string(date-time) |
Payment Due Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentMethod string |
Payment Method |
currency string |
Currency used on the invoice |
subTotal number |
This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
discountPercent number |
Discount Percent |
discountAmount number |
Total Discount |
totalAmount number |
Total Amount |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
subjectToWht boolean |
Subject to withholding tax |
withholdingTaxDetails object |
A representation of withholding tax details when withholding tax configuration is enabled |
whtCode string |
Withholding tax code |
whtType string |
Withholding tax type |
withholdingTaxBaseAmount number |
Total withholding tax base amount |
withholdingTaxAmount number |
Total withholding tax amount |
supplierPayableAmount number |
Supplier payable amount |
comments string |
Comments |
notesFromSupplier string |
Some notes from supplier |
supplierAccountNumber string |
Supplier Account Number |
supplierAccountNumbers [string] |
Set of unique supplier account numbers |
vendorInvoiceNumber string |
Vendor Invoice Number |
vendorInvoiceLink string |
Vendor Invoice Link |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
billingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
items [object] |
No description |
id stringrequired |
Unique identifier for this object. |
lineNumber string |
No description |
description stringrequired |
No description |
quantity numberrequired |
No description |
unitOfMeasure stringrequired |
No description |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
shippingCharges number |
No description |
currencyCode string |
No description |
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
poLineNumber number |
This field is deprecated in favor of poLineItemRef. |
poLineItemId string |
System generated unique identifier for a PO Line Item. This field is deprecated in favor of poLineItemRef. |
subtotal number |
This field is read only. |
amount number |
Amount value to be used as subtotal, this field is optional and if provided the system will not calculate subtotal based on unit price and quantity. Any amount greater than zero will be considered as valid value. |
unitPrice numberrequired |
No description |
useTax number |
No description |
discountAmount number |
No description |
finalInvoice boolean |
This flag indicates whether the reference object has been finalInvoice. If true, this will also update the Purchase Order line finalInvoice flag to true. Purchase Order item and header status is recalculated. If false, create invoice flows will not impact the finalInvoice flag in Purchase Order line item, whereas update invoice flow will impact only if it was set to true in the invoice item. The Purchase Order line item finalInvoice will be updated to false and Purchase Order item and header status is recalculated. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemType string |
No description |
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
category string |
Category |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItemRef object |
Reference to a PO line item. |
itemId string |
System generated unique identifier for a PO Line Item. |
lineNumber number |
No description |
invoiceLineItemRef object |
Reference to an invoice line item. |
itemId string |
Unique identifier for an Invoice Line Item. |
lineNumber string |
No description |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
additionalAccountingInfo object |
Object to update invoice status (Read only). |
taxGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingChargesGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceLineIndicator object |
Object to indicate line item level details (Read only). |
isShippingInLine boolean |
This flag will be true if there is shippingCharges with value greater than 0 in any one of the invoice line item, otherwise it will be false. |
isTaxInLine boolean |
This flag will be true if there is taxAmount with value greater than 0 in any one of the invoice line item, otherwise it will be false. |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
documentConfigurations object |
A representation of document configuration model |
distributionSettings object |
A representation of distribution settings data model |
taxDistributionType string |
The type of tax amount distribution |
shippingDistributionType string |
The type of shipping charges distribution |
discountDistributionType string |
The type of discount amount distribution |
decimalSettings object |
A represenatation of decimal settings data model |
minFractionDigits number |
The minimum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
maxFractionDigitis number |
The maximum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
roundItemSubtotal boolean |
This flag will be trie if the items’ sub total needs to rounded off. |
Enumerated Values
| Property | Value |
|---|---|
type |
STANDARD |
type |
STOCK |
type |
BLANKET |
status |
POSTING |
status |
DRAFT |
status |
PARKED |
status |
CODING |
status |
RECONCILIATION |
status |
PENDING |
status |
APPROVED |
status |
BLOCKED |
status |
READY_TO_POST |
status |
PARTIAL_PAYMENT |
status |
PAID |
status |
REJECTED |
status |
POSTING_FAILED |
status |
POSTED |
type |
PurchaseOrderModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
PurchaseRequestModel |
type |
UserModel |
type |
PaymentTermModel |
type |
CompanyCodeModel |
type |
CompanyCodeModel |
type |
SupplierModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
TaxCodeModel |
type |
PlantCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
CompanyCodeModel |
itemType |
PRODUCT |
itemType |
SERVICE |
itemType |
INVOICEPLAN |
itemType |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
GlAccountModel |
type |
GlAccountModel |
taxDistributionType |
PROPORTIONAL_TO_ESTIMATED_TAX |
taxDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
taxDistributionType |
FIRST_LINE_ITEM |
taxDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
taxDistributionType |
DO_NOT_DISTRIBUTE |
shippingDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
shippingDistributionType |
PROPORTIONAL_TO_QUANTITY |
shippingDistributionType |
FIRST_LINE_ITEM |
shippingDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
shippingDistributionType |
DO_NOT_DISTRIBUTE |
discountDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
discountDistributionType |
PROPORTIONAL_TO_QUANTITY |
discountDistributionType |
FIRST_LINE_ITEM |
discountDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
discountDistributionType |
DO_NOT_DISTRIBUTE |
InvoiceModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "20010001",
"invoiceNumber": "9000001616",
"referenceDocNumber": "123456789",
"type": "STANDARD",
"status": "POSTED",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRefs": [
{
"type": "PurchaseOrderModel"
}
],
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRefs": [
{
"type": "PurchaseRequestModel"
}
],
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"postingDate": "2017-06-28T22:05:47.368+0000",
"invoiceDate": "2017-06-28T22:05:47.368+0000",
"clearingDate": "2017-06-28T22:05:47.368+0000",
"baselineDate": "2017-06-28T22:05:47.368+0000",
"parkedDate": "2017-06-28T22:05:47.368+0000",
"paymentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"paymentMethod": "ACH",
"currency": "USD",
"subTotal": 200.87,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"discountPercent": 5,
"discountAmount": 25,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"withholdingTaxBaseAmount": 0,
"withholdingTaxAmount": 0,
"supplierPayableAmount": 2000.44,
"comments": "Sample comment",
"notesFromSupplier": "Some comments from the supplier",
"supplierAccountNumber": "123456789",
"supplierAccountNumbers": [
"string"
],
"vendorInvoiceNumber": "123456789",
"vendorInvoiceLink": "https://www.vroozi.com/invoice/link.pdf",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"invoiceLineIndicator": {
"isShippingInLine": false,
"isTaxInLine": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
}
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
invoiceNumber string |
System generated unique number (Read only). |
referenceDocNumber string |
Reference DocNumber |
type string |
Type |
status string |
Status of the invoice |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
postingDate string(date-time) |
Posting Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
invoiceDate string(date-time) |
Invoice Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
clearingDate string(date-time) |
Clearing Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
baselineDate string(date-time) |
Baseline Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
parkedDate string(date-time) |
Parked Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentDate string(date-time) |
Payment Date |
paymentDueDate string(date-time) |
Payment Due Date of the invoice document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentMethod string |
Payment Method |
currency string |
Currency used on the invoice |
subTotal number |
This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
discountPercent number |
Discount Percent |
discountAmount number |
Total Discount |
totalAmount number |
Total Amount |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
subjectToWht boolean |
Subject to withholding tax |
withholdingTaxDetails object |
A representation of withholding tax details when withholding tax configuration is enabled |
whtCode string |
Withholding tax code |
whtType string |
Withholding tax type |
withholdingTaxBaseAmount number |
Total withholding tax base amount |
withholdingTaxAmount number |
Total withholding tax amount |
supplierPayableAmount number |
Supplier payable amount |
comments string |
Comments |
notesFromSupplier string |
Some notes from supplier |
supplierAccountNumber string |
Supplier Account Number |
supplierAccountNumbers [string] |
Set of unique supplier account numbers |
vendorInvoiceNumber string |
Vendor Invoice Number |
vendorInvoiceLink string |
Vendor Invoice Link |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
billingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
items [object] |
No description |
id stringrequired |
Unique identifier for this object. |
lineNumber string |
No description |
description stringrequired |
No description |
quantity numberrequired |
No description |
unitOfMeasure stringrequired |
No description |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
shippingCharges number |
No description |
currencyCode string |
No description |
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
poLineNumber number |
This field is deprecated in favor of poLineItemRef. |
poLineItemId string |
System generated unique identifier for a PO Line Item. This field is deprecated in favor of poLineItemRef. |
subtotal number |
This field is read only. |
amount number |
Amount value to be used as subtotal, this field is optional and if provided the system will not calculate subtotal based on unit price and quantity. Any amount greater than zero will be considered as valid value. |
unitPrice numberrequired |
No description |
useTax number |
No description |
discountAmount number |
No description |
finalInvoice boolean |
This flag indicates whether the reference object has been finalInvoice. If true, this will also update the Purchase Order line finalInvoice flag to true. Purchase Order item and header status is recalculated. If false, create invoice flows will not impact the finalInvoice flag in Purchase Order line item, whereas update invoice flow will impact only if it was set to true in the invoice item. The Purchase Order line item finalInvoice will be updated to false and Purchase Order item and header status is recalculated. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemType string |
No description |
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
category string |
Category |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItemRef object |
Reference to a PO line item. |
itemId string |
System generated unique identifier for a PO Line Item. |
lineNumber number |
No description |
invoiceLineItemRef object |
Reference to an invoice line item. |
itemId string |
Unique identifier for an Invoice Line Item. |
lineNumber string |
No description |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
additionalAccountingInfo object |
Object to update invoice status (Read only). |
taxGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingChargesGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceLineIndicator object |
Object to indicate line item level details (Read only). |
isShippingInLine boolean |
This flag will be true if there is shippingCharges with value greater than 0 in any one of the invoice line item, otherwise it will be false. |
isTaxInLine boolean |
This flag will be true if there is taxAmount with value greater than 0 in any one of the invoice line item, otherwise it will be false. |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
documentConfigurations object |
A representation of document configuration model |
distributionSettings object |
A representation of distribution settings data model |
taxDistributionType string |
The type of tax amount distribution |
shippingDistributionType string |
The type of shipping charges distribution |
discountDistributionType string |
The type of discount amount distribution |
decimalSettings object |
A represenatation of decimal settings data model |
minFractionDigits number |
The minimum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
maxFractionDigitis number |
The maximum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
roundItemSubtotal boolean |
This flag will be trie if the items’ sub total needs to rounded off. |
Enumerated Values
| Property | Value |
|---|---|
type |
STANDARD |
type |
STOCK |
type |
BLANKET |
status |
POSTING |
status |
DRAFT |
status |
PARKED |
status |
CODING |
status |
RECONCILIATION |
status |
PENDING |
status |
APPROVED |
status |
BLOCKED |
status |
READY_TO_POST |
status |
PARTIAL_PAYMENT |
status |
PAID |
status |
REJECTED |
status |
POSTING_FAILED |
status |
POSTED |
type |
PurchaseOrderModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
PurchaseRequestModel |
type |
UserModel |
type |
PaymentTermModel |
type |
CompanyCodeModel |
type |
CompanyCodeModel |
type |
SupplierModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
TaxCodeModel |
type |
PlantCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
CompanyCodeModel |
itemType |
PRODUCT |
itemType |
SERVICE |
itemType |
INVOICEPLAN |
itemType |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
GlAccountModel |
type |
GlAccountModel |
taxDistributionType |
PROPORTIONAL_TO_ESTIMATED_TAX |
taxDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
taxDistributionType |
FIRST_LINE_ITEM |
taxDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
taxDistributionType |
DO_NOT_DISTRIBUTE |
shippingDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
shippingDistributionType |
PROPORTIONAL_TO_QUANTITY |
shippingDistributionType |
FIRST_LINE_ITEM |
shippingDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
shippingDistributionType |
DO_NOT_DISTRIBUTE |
discountDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
discountDistributionType |
PROPORTIONAL_TO_QUANTITY |
discountDistributionType |
FIRST_LINE_ITEM |
discountDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
discountDistributionType |
DO_NOT_DISTRIBUTE |
InvoiceStatusListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.23,
"taxAmount": 20.43,
"shippingCharges": "10",
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 222.222,
"totalAmountWithUseTax": 333.033,
"invoiceNumber": "9000001616",
"status": "POSTED",
"invoiceDate": "2017-06-28T22:05:47.368+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of invoices’ summaries |
Invoice Summary object |
A representation of invoice status data model |
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
postingDate string(date-time) |
Posting Date |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
invoiceNumber string |
System generated unique number (Read only). |
status string |
Status of the invoice summary |
invoiceDate string(date-time) |
Invoice summary Date |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING |
status |
PENDING |
status |
PARTIAL_PAYMENT |
status |
PAID |
status |
POSTING_FAILED |
status |
POSTED |
InvoiceStatusModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.23,
"taxAmount": 20.43,
"shippingCharges": "10",
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 222.222,
"totalAmountWithUseTax": 333.033,
"invoiceNumber": "9000001616",
"status": "POSTED",
"invoiceDate": "2017-06-28T22:05:47.368+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
postingDate string(date-time) |
Posting Date |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
invoiceNumber string |
System generated unique number (Read only). |
status string |
Status of the invoice summary |
invoiceDate string(date-time) |
Invoice summary Date |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING |
status |
PENDING |
status |
PARTIAL_PAYMENT |
status |
PAID |
status |
POSTING_FAILED |
status |
POSTED |
InvoiceStatusUpdateModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"autoRepost": false,
"comments": "Posting has failed"
}
Properties
| Name | Description |
|---|---|
id string |
Internal Mongo ID |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Document |
autoRepost boolean |
Setting this flag true will move POSTING_FAILED invoice into POSTING status. |
comments string |
Comments |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING_FAILED |
status |
POSTED |
LocationListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Locations. |
Location object |
A representation of the Location |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this location for business use. |
name stringrequired |
Name of this location for business use. |
description string |
Location LC01. |
enableForAllCompanyCodes boolean |
Setting this true will disable the CompanyCodeRef |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
If any of the referenced company codes has a location types (locationTypeRequired) enabled than locationTypeRef will be required. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this location is active in the system. true means active and false means inactive. Default: false |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
type |
ClassModel |
LocationModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LC01",
"name": "LC01",
"description": "Location LC01",
"enableForAllCompanyCodes": false,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this location for business use. |
name stringrequired |
Name of this location for business use. |
description string |
Location LC01. |
enableForAllCompanyCodes boolean |
Setting this true will disable the CompanyCodeRef |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
If any of the referenced company codes has a location types (locationTypeRequired) enabled than locationTypeRef will be required. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this location is active in the system. true means active and false means inactive. Default: false |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
type |
PlantCodeModel |
type |
LocationTypeModel |
type |
ClassModel |
LocationTypeListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Location Types. |
Location Type object |
A representation of the Location Type |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this location type for business use. |
name stringrequired |
Name of this location type for business use. |
description string |
Description for this location type. |
active boolean |
To indicate whether or not this location type is active in the system. true means active and false means inactive. |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
LocationTypeModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "LT01",
"name": "LT01",
"description": "Location Type 01",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this location type for business use. |
name stringrequired |
Name of this location type for business use. |
description string |
Description for this location type. |
active boolean |
To indicate whether or not this location type is active in the system. true means active and false means inactive. |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
MasterDataAsyncTransmission
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "/approval-groups/bulk-upsert/async",
"requestMethod": "POST",
"documentType": "string",
"payload": [
{
"requestBody": {
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"channel": "CHA-1",
"description": "Approval Group 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"status": "ERROR"
}
],
"stats": {
"total": 1,
"success": 0,
"errors": 1,
"failed": 0,
"pending": 0
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
trackingId string |
System generated id to uniquely identify budget status update request |
requestPath string |
request url from where request is received |
requestMethod string |
http method of the request |
documentType string |
document type |
payload [allOf] |
Array of async request detail. |
allOf
| Name | Description |
|---|---|
anonymous object |
A representation of tracking progress of async requests. |
requestBody object |
A representation of the Approval Group |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this approval groups for business use. |
channel stringrequired |
Channel of this approval groups for business use. |
description stringrequired |
Description for this approval group. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this approval groups is active in the system. true means active and false means inactive. Default: false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
errors [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
and
| Name | Description |
|---|---|
anonymous object |
No description |
status string |
Async Operation Status of approval group |
continued
| Name | Description |
|---|---|
stats object |
Represents the metadata associated with an asynchronous bulk request, including details on the total number of operations and their statuses. |
total number |
The total number of items included in the bulk upsert request. |
success number |
The number of items that were successfully processed. |
errors number |
The number of items that encountered errors during processing. |
failed number |
The number of items that failed to process successfully. |
pending number |
The number of items that are still pending and have not yet been processed. |
status string |
Processing status of Async Request |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
status |
PENDING |
status |
SUCCESS |
status |
ERROR |
status |
FAILED |
status |
IN_PROGRESS |
status |
COMPLETED |
status |
COMPLETED_WITH_ERRORS |
status |
COMPLETED_WITH_FAILURE |
MemoListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of memos. |
Memo object |
A representation of memo |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
documentNumber string |
Auto-generated sequenced number (Read only). |
status string |
Memo’s current status. |
memoType string |
Memo type |
reason string |
Purpose of memo. This field is deprecated in favor of reasonDetail. |
reasonDetail object |
Reason details for document. |
code string |
Reason type for memo. If OTHER reason code is selected then description must be provided. |
description string |
No description |
memoDate string(date-time)required |
Memo Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
postingDate string(date-time) |
Posting Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
parkedDate string(date-time) |
Parked Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
lastStatusChangeDate string(date-time) |
Last Status Change Date (Read only). |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
documentConfigurations object |
A representation of document configuration model |
distributionSettings object |
A representation of distribution settings data model |
taxDistributionType string |
The type of tax amount distribution |
shippingDistributionType string |
The type of shipping charges distribution |
discountDistributionType string |
The type of discount amount distribution |
decimalSettings object |
A represenatation of decimal settings data model |
minFractionDigits number |
The minimum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
maxFractionDigitis number |
The maximum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
roundItemSubtotal boolean |
This flag will be trie if the items’ sub total needs to rounded off. |
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
supplierAccountNumber string |
Supplier Account Number |
vendorMemoNumber string |
Vendor Memo Number |
vendorInvoiceNumber string |
Vendor Invoice Number |
items [object] |
No description |
id stringrequired |
Unique identifier for this object. |
lineNumber string |
No description |
description stringrequired |
No description |
quantity numberrequired |
No description |
unitOfMeasure stringrequired |
No description |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
shippingCharges number |
No description |
currencyCode string |
No description |
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
poLineNumber number |
This field is deprecated in favor of poLineItemRef. |
poLineItemId string |
System generated unique identifier for a PO Line Item. This field is deprecated in favor of poLineItemRef. |
subtotal number |
This field is read only. |
amount number |
Amount value to be used as subtotal, this field is optional and if provided the system will not calculate subtotal based on unit price and quantity. Any amount greater than zero will be considered as valid value. |
unitPrice numberrequired |
No description |
useTax number |
No description |
discountAmount number |
No description |
finalInvoice boolean |
This flag indicates whether the reference object has been finalInvoice. If true, this will also update the Purchase Order line finalInvoice flag to true. Purchase Order item and header status is recalculated. If false, create invoice flows will not impact the finalInvoice flag in Purchase Order line item, whereas update invoice flow will impact only if it was set to true in the invoice item. The Purchase Order line item finalInvoice will be updated to false and Purchase Order item and header status is recalculated. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemType string |
No description |
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
category string |
Category |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItemRef object |
Reference to a PO line item. |
itemId string |
System generated unique identifier for a PO Line Item. |
lineNumber number |
No description |
invoiceLineItemRef object |
Reference to an invoice line item. |
itemId string |
Unique identifier for an Invoice Line Item. |
lineNumber string |
No description |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
additionalAccountingInfo object |
Object to update invoice status (Read only). |
taxGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingChargesGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount (Read only) |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
subTotal number |
Subtotal (Read only) |
discountPercent number |
Discount percent |
discountAmount number |
Discount amount |
currency string |
Currency used on the invoice |
comments string |
Comments |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
reInvoicingOption string |
Re Invoicing Option, it will have an impact on the eligibility of Purchase Orders for re-invoicing. Users have the flexibility to choose from a range of supported values. REOPEN_PO, this option allows the items in the memo to be available for invoicing, and the purchase order status will be changed to the previous status before it was invoiced. DONOT_REOPEN_PO, this option ensures that the items won’t be available for invoicing, and the purchase order status will remain unchanged. KEEP_AS_IS, when this option is selected, the purchase order status will be kept as is, but the items will be made available for invoicing. |
Enumerated Values
| Property | Value |
|---|---|
status |
DRAFT |
status |
CODING |
status |
PARKED |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
READY_TO_POST |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
memoType |
CREDIT |
memoType |
DEBIT |
reason |
RETURNED_ITEMS |
reason |
REBATES |
reason |
BILLING_ERROR |
reason |
OTHER |
code |
RETURNED_ITEMS |
code |
REBATES |
code |
BILLING_ERROR |
code |
OTHER |
type |
PurchaseOrderModel |
type |
InvoiceModel |
type |
CompanyCodeModel |
type |
UserModel |
taxDistributionType |
PROPORTIONAL_TO_ESTIMATED_TAX |
taxDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
taxDistributionType |
FIRST_LINE_ITEM |
taxDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
taxDistributionType |
DO_NOT_DISTRIBUTE |
shippingDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
shippingDistributionType |
PROPORTIONAL_TO_QUANTITY |
shippingDistributionType |
FIRST_LINE_ITEM |
shippingDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
shippingDistributionType |
DO_NOT_DISTRIBUTE |
discountDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
discountDistributionType |
PROPORTIONAL_TO_QUANTITY |
discountDistributionType |
FIRST_LINE_ITEM |
discountDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
discountDistributionType |
DO_NOT_DISTRIBUTE |
type |
SupplierModel |
type |
TaxCodeModel |
type |
PlantCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
CompanyCodeModel |
itemType |
PRODUCT |
itemType |
SERVICE |
itemType |
INVOICEPLAN |
itemType |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
GlAccountModel |
type |
GlAccountModel |
reInvoicingOption |
REOPEN_PO |
reInvoicingOption |
DONOT_REOPEN_PO |
reInvoicingOption |
KEEP_AS_IS |
MemoModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"documentNumber": "9500000335",
"status": "POSTED",
"memoType": "CREDIT",
"reason": "BILLING_ERROR",
"reasonDetail": {
"code": "BILLING_ERROR",
"description": "Something related to reason code."
},
"memoDate": "2018-03-15T13:56:04.037+0000",
"postingDate": "2018-03-15T13:56:04.037+0000",
"parkedDate": "2018-03-15T13:56:04.037+0000",
"lastStatusChangeDate": "2018-03-15T13:56:04.037+0000",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"invoiceRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InvoiceModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"documentConfigurations": {
"distributionSettings": {
"taxDistributionType": "EQUALLY_BETWEEN_LINE_ITEMS",
"shippingDistributionType": "PROPORTIONAL_TO_SUBTOTAL",
"discountDistributionType": "PROPORTIONAL_TO_SUBTOTAL"
},
"decimalSettings": {
"minFractionDigits": 2,
"maxFractionDigitis": 3,
"roundItemSubtotal": false
}
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"supplierAccountNumber": "4568798",
"vendorMemoNumber": "980054421211",
"vendorInvoiceNumber": "980054421211",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"quantity": 2.4,
"unitOfMeasure": "EA",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxAmount": 100.6,
"taxPercentage": 9.5,
"shippingCharges": 20.7,
"currencyCode": "USD",
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"poLineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"poLineNumber": 1,
"poLineItemId": "118",
"subtotal": 200.8,
"amount": 200.8,
"unitPrice": 300.1,
"useTax": 3.1,
"discountAmount": 10,
"finalInvoice": true,
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"itemType": "PRODUCT",
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"category": "category",
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"poLineItemRef": {
"itemId": "118",
"lineNumber": 7
},
"invoiceLineItemRef": {
"itemId": "118",
"lineNumber": "7"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
}
}
],
"additionalAccountingInfo": {
"taxGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"shippingChargesGLAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
}
},
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"totalUseTax": 0,
"totalAmountWithUseTax": 0,
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"currency": "USD",
"comments": "Sample comment",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"reInvoicingOption": "DONOT_REOPEN_PO"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
documentNumber string |
Auto-generated sequenced number (Read only). |
status string |
Memo’s current status. |
memoType string |
Memo type |
reason string |
Purpose of memo. This field is deprecated in favor of reasonDetail. |
reasonDetail object |
Reason details for document. |
code string |
Reason type for memo. If OTHER reason code is selected then description must be provided. |
description string |
No description |
memoDate string(date-time)required |
Memo Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
postingDate string(date-time) |
Posting Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
parkedDate string(date-time) |
Parked Date of the memo document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
lastStatusChangeDate string(date-time) |
Last Status Change Date (Read only). |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
documentConfigurations object |
A representation of document configuration model |
distributionSettings object |
A representation of distribution settings data model |
taxDistributionType string |
The type of tax amount distribution |
shippingDistributionType string |
The type of shipping charges distribution |
discountDistributionType string |
The type of discount amount distribution |
decimalSettings object |
A represenatation of decimal settings data model |
minFractionDigits number |
The minimum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
maxFractionDigitis number |
The maximum number of fraction digits to use while rounding amounts. The value should be greater than or equal to 0. |
roundItemSubtotal boolean |
This flag will be trie if the items’ sub total needs to rounded off. |
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
supplierAccountNumber string |
Supplier Account Number |
vendorMemoNumber string |
Vendor Memo Number |
vendorInvoiceNumber string |
Vendor Invoice Number |
items [object] |
No description |
id stringrequired |
Unique identifier for this object. |
lineNumber string |
No description |
description stringrequired |
No description |
quantity numberrequired |
No description |
unitOfMeasure stringrequired |
No description |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
shippingCharges number |
No description |
currencyCode string |
No description |
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
poLineNumber number |
This field is deprecated in favor of poLineItemRef. |
poLineItemId string |
System generated unique identifier for a PO Line Item. This field is deprecated in favor of poLineItemRef. |
subtotal number |
This field is read only. |
amount number |
Amount value to be used as subtotal, this field is optional and if provided the system will not calculate subtotal based on unit price and quantity. Any amount greater than zero will be considered as valid value. |
unitPrice numberrequired |
No description |
useTax number |
No description |
discountAmount number |
No description |
finalInvoice boolean |
This flag indicates whether the reference object has been finalInvoice. If true, this will also update the Purchase Order line finalInvoice flag to true. Purchase Order item and header status is recalculated. If false, create invoice flows will not impact the finalInvoice flag in Purchase Order line item, whereas update invoice flow will impact only if it was set to true in the invoice item. The Purchase Order line item finalInvoice will be updated to false and Purchase Order item and header status is recalculated. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemType string |
No description |
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
category string |
Category |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poLineItemRef object |
Reference to a PO line item. |
itemId string |
System generated unique identifier for a PO Line Item. |
lineNumber number |
No description |
invoiceLineItemRef object |
Reference to an invoice line item. |
itemId string |
Unique identifier for an Invoice Line Item. |
lineNumber string |
No description |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
additionalAccountingInfo object |
Object to update invoice status (Read only). |
taxGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingChargesGLAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount (Read only) |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
subTotal number |
Subtotal (Read only) |
discountPercent number |
Discount percent |
discountAmount number |
Discount amount |
currency string |
Currency used on the invoice |
comments string |
Comments |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
reInvoicingOption string |
Re Invoicing Option, it will have an impact on the eligibility of Purchase Orders for re-invoicing. Users have the flexibility to choose from a range of supported values. REOPEN_PO, this option allows the items in the memo to be available for invoicing, and the purchase order status will be changed to the previous status before it was invoiced. DONOT_REOPEN_PO, this option ensures that the items won’t be available for invoicing, and the purchase order status will remain unchanged. KEEP_AS_IS, when this option is selected, the purchase order status will be kept as is, but the items will be made available for invoicing. |
Enumerated Values
| Property | Value |
|---|---|
status |
DRAFT |
status |
CODING |
status |
PARKED |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
READY_TO_POST |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
memoType |
CREDIT |
memoType |
DEBIT |
reason |
RETURNED_ITEMS |
reason |
REBATES |
reason |
BILLING_ERROR |
reason |
OTHER |
code |
RETURNED_ITEMS |
code |
REBATES |
code |
BILLING_ERROR |
code |
OTHER |
type |
PurchaseOrderModel |
type |
InvoiceModel |
type |
CompanyCodeModel |
type |
UserModel |
taxDistributionType |
PROPORTIONAL_TO_ESTIMATED_TAX |
taxDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
taxDistributionType |
FIRST_LINE_ITEM |
taxDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
taxDistributionType |
DO_NOT_DISTRIBUTE |
shippingDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
shippingDistributionType |
PROPORTIONAL_TO_QUANTITY |
shippingDistributionType |
FIRST_LINE_ITEM |
shippingDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
shippingDistributionType |
DO_NOT_DISTRIBUTE |
discountDistributionType |
PROPORTIONAL_TO_SUBTOTAL |
discountDistributionType |
PROPORTIONAL_TO_QUANTITY |
discountDistributionType |
FIRST_LINE_ITEM |
discountDistributionType |
EQUALLY_BETWEEN_LINE_ITEMS |
discountDistributionType |
DO_NOT_DISTRIBUTE |
type |
SupplierModel |
type |
TaxCodeModel |
type |
PlantCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
CompanyCodeModel |
itemType |
PRODUCT |
itemType |
SERVICE |
itemType |
INVOICEPLAN |
itemType |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
GlAccountModel |
type |
GlAccountModel |
reInvoicingOption |
REOPEN_PO |
reInvoicingOption |
DONOT_REOPEN_PO |
reInvoicingOption |
KEEP_AS_IS |
MemoStatusListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.87,
"taxAmount": 20.48,
"shippingCharges": 10.74,
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 2,
"totalAmountWithUseTax": 0.78,
"status": "POSTED",
"memoNumber": "9500000335",
"memoDate": "2018-03-15T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of memos’ summaries. |
Memo Summary object |
A representation of memo summary |
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
postingDate string(date-time) |
Posting Date |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
status string |
Memo’s current summary. |
memoNumber string |
Memo Number |
memoDate string(date-time) |
Memo Date |
Enumerated Values
| Property | Value |
|---|---|
status |
PENDING |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
MemoStatusModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.87,
"taxAmount": 20.48,
"shippingCharges": 10.74,
"totalAmount": 2002.43,
"itemsCount": 2,
"postingDate": "2018-03-15T13:56:04.037+0000",
"totalUseTax": 2,
"totalAmountWithUseTax": 0.78,
"status": "POSTED",
"memoNumber": "9500000335",
"memoDate": "2018-03-15T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
postingDate string(date-time) |
Posting Date |
totalUseTax number |
Total Use Tax |
totalAmountWithUseTax number |
Total Amount With Use Tax |
status string |
Memo’s current summary. |
memoNumber string |
Memo Number |
memoDate string(date-time) |
Memo Date |
Enumerated Values
| Property | Value |
|---|---|
status |
PENDING |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
MemoStatusUpdateModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100238",
"docNo": "CC01",
"status": "POSTING_FAILED",
"comments": "Posting has failed"
}
Properties
| Name | Description |
|---|---|
id string |
Internal Mongo ID |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Document |
comments string |
Comments |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTING_FAILED |
status |
POSTED |
OwnershipTransferRequestDetailModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"metadata": {
"transferDetails": {
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
},
"content": [
[
{
"type": "PurchaseOrderModel"
}
]
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
metadata object |
No description |
transferDetails object |
A representation of ownership transfer object |
id string |
System generated unique identifier for this object. |
docType string |
Document Type for ownership changes |
previousOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
newOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
totalDocuments number |
Total number of documents affected |
status string |
Ownership Transfer request’s status. |
comments string |
Comments added for ownership transfer status update |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
totalExecutedDocuments number |
count of all the documents in a transfer that are updated in vroozi |
updateDetails [object] |
List of documents updated in this request, only provided in the case of partial update with EXECUTED status |
documentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
executionStatus string |
Ownership Transfer detail’s status. |
comments string |
Comments added for ownership transfer detail’s status update |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
content [allOf] |
Array of reference models. |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type any |
No description |
Enumerated Values
| Property | Value |
|---|---|
docType |
PurchaseOrderModel |
type |
UserModel |
type |
UserModel |
status |
PENDING |
status |
ACKNOWLEDGED |
status |
EXECUTED |
status |
FAILED |
status |
PARTIALLY_EXECUTED |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
executionStatus |
SUCCESS |
executionStatus |
ERROR |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
OwnershipTransferRequestListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of ownership transfer requests. |
Ownership Transfer Requests object |
A representation of ownership transfer object |
id string |
System generated unique identifier for this object. |
docType string |
Document Type for ownership changes |
previousOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
newOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
totalDocuments number |
Total number of documents affected |
status string |
Ownership Transfer request’s status. |
comments string |
Comments added for ownership transfer status update |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
totalExecutedDocuments number |
count of all the documents in a transfer that are updated in vroozi |
updateDetails [object] |
List of documents updated in this request, only provided in the case of partial update with EXECUTED status |
documentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
executionStatus string |
Ownership Transfer detail’s status. |
comments string |
Comments added for ownership transfer detail’s status update |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
docType |
PurchaseOrderModel |
type |
UserModel |
type |
UserModel |
status |
PENDING |
status |
ACKNOWLEDGED |
status |
EXECUTED |
status |
FAILED |
status |
PARTIALLY_EXECUTED |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
executionStatus |
SUCCESS |
executionStatus |
ERROR |
OwnershipTransferRequestModel
{
"id": "5abbd758e61c824a33ded63a",
"docType": "PurchaseOrderModel",
"previousOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"newOwnerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"totalDocuments": 150,
"status": "PENDING",
"comments": "Ownership executed externally",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"totalExecutedDocuments": 0,
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
],
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
docType string |
Document Type for ownership changes |
previousOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
newOwnerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
totalDocuments number |
Total number of documents affected |
status string |
Ownership Transfer request’s status. |
comments string |
Comments added for ownership transfer status update |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
totalExecutedDocuments number |
count of all the documents in a transfer that are updated in vroozi |
updateDetails [object] |
List of documents updated in this request, only provided in the case of partial update with EXECUTED status |
documentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
executionStatus string |
Ownership Transfer detail’s status. |
comments string |
Comments added for ownership transfer detail’s status update |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
docType |
PurchaseOrderModel |
type |
UserModel |
type |
UserModel |
status |
PENDING |
status |
ACKNOWLEDGED |
status |
EXECUTED |
status |
FAILED |
status |
PARTIALLY_EXECUTED |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
executionStatus |
SUCCESS |
executionStatus |
ERROR |
OwnershipTransferStatusUpdateModel
{
"id": "561234cdeacb256789aa",
"comments": "Ownership executed externally",
"status": "ACKNOWLEDGED",
"updateDetails": [
{
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"executionStatus": "SUCCESS",
"comments": "PO Ownership executed externally"
}
]
}
Properties
| Name | Description |
|---|---|
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
comments string |
Comment for the status update. |
status string |
The status to update for Ownership Transfer Requests |
updateDetails [object] |
Ownership transfer document details that needs to be updated, only supported with EXECUTED status. Details can be used to send partial execution status for documents in a transfer request and only supported with EXECUTED status. If provided with other transfer statuses, the details are ignored and the entire transfer history is moved to provided status e.g ACKNOWLEDGED/FAILED. Only one status update can be sent per document detail and an error is thrown if the user tries to update one detail multiple times. For another update of the same detail, user can create a new transfer request. |
documentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
executionStatus string |
Ownership Transfer detail’s status. |
comments string |
Comments added for ownership transfer detail’s status update |
Enumerated Values
| Property | Value |
|---|---|
status |
ACKNOWLEDGED |
status |
EXECUTED |
status |
FAILED |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
executionStatus |
SUCCESS |
executionStatus |
ERROR |
POGoodsReceiptReturnModel
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"goodsRceipts": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"receiptNumber": "3000000614",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"finalReceipt": true,
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"comments": "Sample comment",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"totalAmount": "2120.34",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 4976.3,
"quantityReceived": 22454.33,
"quantityOutstanding": 443245,
"quantityInvoiced": 665444,
"valueOrdered": 200,
"valueReceived": 150,
"valueOutstanding": 50,
"uom": "EA",
"unitPrice": 200.9,
"priceUnit": 1,
"totalPrice": 800.99,
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-28T22:05:47.368+0000",
"cancelable": false,
"canceled": false
}
]
}
],
"goodsReturns": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"returnNumber": "3000000614",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"rmaNumber": "2736384",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"billOfLading": "bill",
"packingSlip": "packing",
"status": "CONFIRMED",
"comments": "Sample comment",
"currency": "USD",
"totalAmount": 2000.89,
"receiptCancelation": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-03-15T13:56:04.037+0000",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1321",
"lineItem": {
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
},
"description": "Sample description",
"receiveBy": "ITEM_VALUE",
"quantityOrdered": 7736.3,
"quantityReturned": 32,
"quantityOutstanding": 2222.22,
"quantityInvoiced": 333.2,
"valueOrdered": 200,
"valueOutstanding": 50,
"valueReturned": 100,
"uom": "EA",
"unitPrice": "200",
"priceUnit": 200,
"totalPrice": "800",
"manufacturerName": "EA",
"manufacturerPartNo": "EA",
"partNo": "EA",
"longDescription": "EA",
"returnReasonCode": "101",
"deliveryDate": "2017-06-28T22:05:47.368+0000",
"actualDeliveryDate": "2017-06-28T22:05:47.368+0000",
"actualServicePeriodFrom": "2017-07-28T22:05:47.368+0000",
"actualServicePeriodTo": "2017-06-29T22:05:47.368+0000"
}
]
}
]
}
Properties
| Name | Description |
|---|---|
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
goodsRceipts [object] |
Array of goods receipt. |
Goods Receipt object |
A representation of Goods Receipt |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
receiptNumber string |
GoodsReceipt’s Receipt Number (Read only). |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
GoodsReceipt’s rmaNumber. |
finalReceipt boolean |
When true, closes PO for receiving after confirming this GR. Effective only when GR is partially confirmed. In case of full reception, this flag is ignored. |
billOfLading string |
GoodsReceipt’s bill of lading. |
packingSlip string |
GoodsReceipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
comments string |
Comments. |
postingDate string(date-time)required |
Posting Date of the Goods receipt document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
currency string |
GoodsReceipt’s currency (Read only). |
totalAmount number |
Total Amount |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber integer |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Receipt’s description |
receiveBy string |
Goods Receipt Item’s received type e.g. receive by Quantity or Value. Receive by Value is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Receipt’s Quantity Ordered (Read only). |
quantityReceived number |
Goods Receipt’s Quantity Received. |
quantityOutstanding number |
Goods Receipt’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Receipt’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueReceived number |
Goods Receipt Item’s Amount Received. |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
uom string |
Goods Receipt’s unit of measure (Read only). |
unitPrice number |
Goods Receipt’s unit price (Read only). |
priceUnit integer |
Goods Receipt’s price unit (Read only). |
totalPrice number |
Goods Receipt’s total price (Read only). |
deliveryDate string(date-time) |
Delivery Date of Goods Receipt (Read only). |
manufacturerName string |
Goods Receipt’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Receipt’s manufacturer part no (Read only). |
partNo string |
Goods Receipt’s Part No (Read only). |
longDescription string |
Goods Receipt’s long description (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Receipt |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Receipt |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Receipt |
cancelable boolean |
Identifies if item is cancelable based on the criteria that no Goods Return or Invoice is created in pending or higher state against this item. |
canceled boolean |
Identifies if item within a Goods Receipt is Canceled. |
goodsReturns [object] |
Array of goods return. |
Goods Return object |
A representation of Goods Return |
id string |
System generated unique identifier for this object (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
returnNumber string |
Goods Receipt’s Return Number (Read only). |
goodsReceiptRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
postingDate string(date-time)required |
Posting Date of the Goods return document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
rmaNumber string |
Goods Receipt’s rmaNumber. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
billOfLading string |
Goods Receipt’s bill of lading. |
packingSlip string |
Goods Receipt’s packing slip. |
status string |
Status of the Goods Receipt (Read only). |
comments string |
Comments. |
currency string |
Goods Receipt’s currency (Read only). |
totalAmount number |
Total Amount |
receiptCancelation boolean |
Identifies if Goods Return documen is created on the basis of Goods Receipt cancelation. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ (Read only). |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber numberrequired |
No description |
poLineItemId string |
No description |
lineItem any |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
description string |
Goods Return’s description |
receiveBy string |
Goods Return Item’s returned type. Receive by ITEM_VALUE is only supported for Service Type Items. If not provided in the request, ITEM_QUANTITY will be used as default. |
quantityOrdered number |
Goods Return’s Quantity Ordered (Read only). |
quantityReturned number |
Goods Return’s Quantity Returned. |
quantityOutstanding number |
Goods Return’s Quantity Outstanding (Read only). |
quantityInvoiced number |
Goods Return’s Quantity Invoiced (Read only). |
valueOrdered number |
Purchase Order Line Item’s amount (Read only). |
valueOutstanding number |
Goods Receipt Item’s Amount Outstanding (Read only). |
valueReturned number |
Goods Return’s Amount Returned. |
uom string |
Goods Return’s unit of measure (Read only). |
unitPrice number |
Goods Return’s unit price (Read only). |
priceUnit integer |
Goods Return’s price unit (Read only). |
totalPrice number |
Goods Return’s total price (Read only). |
manufacturerName string |
Goods Return’s manufacturer name (Read only). |
manufacturerPartNo string |
Goods Return’s manufacturer part no (Read only). |
partNo string |
Goods Return’s Part No (Read only). |
longDescription string |
Goods Return’s long description (Read only). |
returnReasonCode string |
Goods Return reason code. The default value is 103 which represents that the item is No Longer NeededPossible values with description are: 101 Defective102 Quality Unacceptable103 No Longer Needed104 Received Late105 Goods Damaged106 Wrong Address107 Wrong Item Sent108 Received in Error |
deliveryDate string(date-time) |
Delivery Date of Goods Return (Read only). |
actualDeliveryDate string(date-time) |
Actual Delivery Date of Goods Return |
actualServicePeriodFrom string(date-time) |
Actual Service Period From of Goods Return |
actualServicePeriodTo string(date-time) |
Actual Service Period To of Goods Return |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
PurchaseOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
DRAFT |
status |
CONFIRMED |
status |
CANCELED |
type |
UserModel |
type |
SupplierModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
type |
GoodsReceiptModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
UserModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
SupplierModel |
status |
DRAFT |
status |
CONFIRMED |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
receiveBy |
ITEM_QUANTITY |
receiveBy |
ITEM_VALUE |
returnReasonCode |
101 |
returnReasonCode |
102 |
returnReasonCode |
103 |
returnReasonCode |
104 |
returnReasonCode |
105 |
returnReasonCode |
106 |
returnReasonCode |
107 |
returnReasonCode |
108 |
POStatusSyncModel
{
"externallySynced": true,
"purchaseOrderRefs": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
}
]
}
Properties
| Name | Description |
|---|---|
externallySynced boolean |
A flag indicating whether the data is synchronized with the external system. |
purchaseOrderRefs [allOf]required |
Array of Purchase Order References. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseOrderModel |
POStatusUpdateModel
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "ORDERED",
"comments": "Updating the Purchase Order Status",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Properties
| Name | Description |
|---|---|
id string |
Internal Mongo ID |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
Document Number |
status stringrequired |
Status of Purchase Order to be updated |
comments string |
Comments |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
status |
CANCELED |
status |
CONFIRMED |
status |
FAILED |
status |
INVOICED |
status |
ORDERED |
type |
UserModel |
PRStatusUpdateModel
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"status": "APPROVED",
"comments": "Updating the Purchase Request Status"
}
Properties
| Name | Description |
|---|---|
id string |
Internal Mongo ID |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
Purchase Request Number |
status stringrequired |
Status of Purchase Request to be updated |
comments string |
Comments |
Enumerated Values
| Property | Value |
|---|---|
status |
APPROVED |
status |
REJECTED |
status |
FAILED |
status |
SUBMITTED |
status |
CANCELED |
PaginationDataModel
{
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
}
Properties
| Name | Description |
|---|---|
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
PaymentModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"paymentNumber": "808829220",
"referenceNo": "123334322",
"paymentName": "1232123",
"paymentDate": "2012-12-12",
"comments": "comments",
"totalAmount": 20.3,
"totalDiscount": 2,
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"items": [
{
"lineNumber": "1",
"description": "Description of the line Payment Item",
"documentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"dueDate": "2017-06-28",
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"originalAmount": 20.3,
"paidAmount": 15.8,
"discountAmount": 2
}
],
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Office Address",
"attentionTo": "Person Name",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "7187372722",
"active": false,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"voided": false,
"voidDetail": {
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
},
"paymentMethod": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
paymentNumber string |
Vroozi generated document number to unique identify a payment. |
referenceNo string |
External system generated payment reference number for this payment. |
paymentName string |
Descriptive name for a payment |
paymentDate string(YYYY-MM-DD)required |
Date when this payment was made. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
comments string |
Additional comments regarding the payment |
totalAmount number |
Total amount that was paid |
totalDiscount number |
Sum of all additional discounts that was given on top of the invoice discounts. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
items [object]required |
List of items that were paid in this payment |
lineNumber numberrequired |
Sequential number for the line item |
description string |
Line Item description |
documentRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
dueDate string(date) |
Original due date for the payment. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
originalAmount number |
Original amount due for payment |
paidAmount numberrequired |
Amount paid in this payment |
discountAmount number |
This is an additional discount provided after the invoice document has been posted. If the discount is already applied in the invoice document, this field shouldn’t not be populated again. It is to support additional discount amount that was given on top of the invoice discount. |
billingAddress object |
A representation of payment billing address |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Name for identifying the payment billing address. |
attentionTo string |
Name of the person or business |
addressType [string] |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
Phone |
active boolean |
Defines if the addtress is active true or not false |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
voided boolean |
Defines if payment is voided or not. true if its voided, false if its not voided. |
voidDetail object |
A representation of Void Payment Request |
paymentRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
voidedDate string(date-time)required |
Date when the payment is voided. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
referenceNo string |
External system generated void reference number for this payment. |
notes string |
Descriptive notes that why payment is to be voided |
paymentMethod string |
Payment Method used |
dateCreated string(date-time) |
Date when the payment document was created |
lastUpdated string(date-time) |
Date when the payment document was last updated |
Enumerated Values
| Property | Value |
|---|---|
type |
SupplierModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
PaymentTermModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PaymentModel |
PaymentRequestCategoryReferenceModel
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
}
Properties
| Name | Description |
|---|---|
id string |
Primary key (ID) of the reference data model (Read only). |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
The category code. |
name string |
The category name. |
label string |
Label displays category name with the catalog code in the following format: Category Name - Category Code. |
type string |
Type of the Reference object. |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. |
Enumerated Values
| Property | Value |
|---|---|
type |
PaymentRequestCategoryModel |
PaymentRequestListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"name": "Pay Jan 20",
"reason": {
"description": "Reason"
},
"comments": "Process it immediately.",
"status": "POSTING",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"specialHandling": {
"required": false,
"option": "NO"
},
"shipTo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"paymentMethod": {
"type": "CHECK"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"documentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currencyCode": "USD",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"categoryRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
},
"currencyCode": "USD",
"unitOfMeasure": "EA",
"quantity": 2.4,
"unitPrice": 300.1,
"subTotal": 200.8,
"discountAmount": 10,
"shippingCharges": 2.3,
"taxAmount": 100.6,
"taxPercentage": 9.5,
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
]
}
],
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of payment requests. |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Document Number of this payment. |
name string |
Name for this payment request. |
reason object |
No description |
description string |
Reason for the payment request |
comments string |
Comments for this payment request. |
status string |
Payment request status |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
specialHandling object |
No description |
required boolean |
To indicate whether or not this handling is required. |
option string |
Payment request status |
shipTo object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
paymentMethod object |
No description |
type string |
Payment method |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
documentDate string(date-time) |
Document date of the Payment request document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentDueDate string(date-time)required |
Payment date of the Payment request document Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
postingDate string(date-time) |
Posting date of the Payment request document Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
currencyCode string |
Purchase order’s currency |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
items [object] |
No description |
id string |
Unique identifier for this object. |
lineNumber string |
The line number |
description string |
The description about the item |
categoryRef object |
Reference to a Payment Request category object |
id string |
Primary key (ID) of the reference data model (Read only). |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
The category code. |
name string |
The category name. |
label string |
Label displays category name with the catalog code in the following format: Category Name - Category Code. |
type string |
Type of the Reference object. |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. |
currencyCode string |
The currency code |
unitOfMeasure string |
No description |
quantity number |
The quantity |
unitPrice number |
The unit price |
subTotal number |
No description |
discountAmount number |
No description |
shippingCharges number |
Shipping Charges |
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
subTotal number |
Subtotal |
discountPercent number |
Discount percent |
discountAmount number |
Discount amount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
status |
CODING |
status |
PAID |
status |
PARTIALLY_PAID |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
READY_TO_POST |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
status |
CANCELED |
type |
UserModel |
type |
SupplierModel |
option |
NO |
option |
|
option |
PICK_UP |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
CompanyCodeModel |
type |
CHECK |
type |
SAME_DAY_ACH |
type |
ACH |
type |
WIRE_TRANSFER |
type |
AP_PREFERRED_METHOD |
type |
SUPPLIER_PREFERRED_METHOD |
type |
PaymentTermModel |
type |
PaymentRequestCategoryModel |
type |
TaxCodeModel |
type |
CompanyCodeModel |
type |
PlantCodeModel |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
PaymentRequestModel
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"name": "Pay Jan 20",
"reason": {
"description": "Reason"
},
"comments": "Process it immediately.",
"status": "POSTING",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"specialHandling": {
"required": false,
"option": "NO"
},
"shipTo": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"paymentMethod": {
"type": "CHECK"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"documentDate": "2017-06-28T22:05:47.368+0000",
"paymentDueDate": "2017-06-28T22:05:47.368+0000",
"postingDate": "2017-06-28T22:05:47.368+0000",
"currencyCode": "USD",
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"lineNumber": 3,
"description": "Sample description",
"categoryRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "Refunds-001",
"name": "Refunds",
"label": "Refunds - Refund-001",
"type": "PaymentRequestCategoryModel",
"archived": false
},
"currencyCode": "USD",
"unitOfMeasure": "EA",
"quantity": 2.4,
"unitPrice": 300.1,
"subTotal": 200.8,
"discountAmount": 10,
"shippingCharges": 2.3,
"taxAmount": 100.6,
"taxPercentage": 9.5,
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"accountDistributionType": "none",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
]
}
],
"subTotal": 200.87,
"discountPercent": 33.31,
"discountAmount": 159.73,
"taxAmount": 20.34,
"shippingCharges": 10.2,
"totalAmount": 2000.44,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Document Number of this payment. |
name string |
Name for this payment request. |
reason object |
No description |
description string |
Reason for the payment request |
comments string |
Comments for this payment request. |
status string |
Payment request status |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
specialHandling object |
No description |
required boolean |
To indicate whether or not this handling is required. |
option string |
Payment request status |
shipTo object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
paymentMethod object |
No description |
type string |
Payment method |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
documentDate string(date-time) |
Document date of the Payment request document. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
paymentDueDate string(date-time)required |
Payment date of the Payment request document Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
postingDate string(date-time) |
Posting date of the Payment request document Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
currencyCode string |
Purchase order’s currency |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
items [object] |
No description |
id string |
Unique identifier for this object. |
lineNumber string |
The line number |
description string |
The description about the item |
categoryRef object |
Reference to a Payment Request category object |
id string |
Primary key (ID) of the reference data model (Read only). |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
The category code. |
name string |
The category name. |
label string |
Label displays category name with the catalog code in the following format: Category Name - Category Code. |
type string |
Type of the Reference object. |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. |
currencyCode string |
The currency code |
unitOfMeasure string |
No description |
quantity number |
The quantity |
unitPrice number |
The unit price |
subTotal number |
No description |
discountAmount number |
No description |
shippingCharges number |
Shipping Charges |
taxAmount number |
No description |
taxPercentage number |
Tax Percentage |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
accountDistributionType string |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
subTotal number |
Subtotal |
discountPercent number |
Discount percent |
discountAmount number |
Discount amount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
status |
CODING |
status |
PAID |
status |
PARTIALLY_PAID |
status |
PENDING_APPROVAL |
status |
APPROVED |
status |
REJECTED |
status |
READY_TO_POST |
status |
POSTING |
status |
POSTED |
status |
POSTING_FAILED |
status |
CANCELED |
type |
UserModel |
type |
SupplierModel |
option |
NO |
option |
|
option |
PICK_UP |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
CompanyCodeModel |
type |
CHECK |
type |
SAME_DAY_ACH |
type |
ACH |
type |
WIRE_TRANSFER |
type |
AP_PREFERRED_METHOD |
type |
SUPPLIER_PREFERRED_METHOD |
type |
PaymentTermModel |
type |
PaymentRequestCategoryModel |
type |
TaxCodeModel |
type |
CompanyCodeModel |
type |
PlantCodeModel |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
PaymentRequestStatusUpdateModel
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"docNo": "AV01",
"comments": "Moving the document to POSTED",
"status": "POSTED",
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"errorType": "DATA_ERROR",
"autoPost": false
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. |
docNo string |
Document Number of this payment. |
comments string |
The comment to be added while updating the status |
status stringrequired |
The Payment Request status |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
errorType string |
The error type, required for POSTING_FAILED status |
autoPost boolean |
This flag is used when sending a POSTING_FAILED status, if it is true the Payment Request will automatically transition from POSTING -> POSTING_FAILED -> POSTING |
Enumerated Values
| Property | Value |
|---|---|
status |
POSTED |
status |
POSTING_FAILED |
type |
UserModel |
errorType |
DATA_ERROR |
errorType |
CONNECTION_ERROR |
PaymentTermListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of payment terms. |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
description string |
Payment term description. Description will be auto generated if not provided based on the payment term details. Ex: If you provide, type as NET, payDays as 30 generated description will be NET 30 |
name stringrequired |
Payment term name. The value of this field should be unique to uniquely identify the records in the transactions. |
type stringrequired |
Available types of Payment Term. Should be one of the following: IMMEDIATE_PAY, NET, DAY_OF_MONTH, DAY_OF_NEXT_MONTH |
payDays integerrequired |
No. of days when the payment will be due. This field is not required when the type is IMMEDIATE_PAY |
discounts [object] |
Discounts available for this payment term. You can specify multiple discounts depending upon your need. |
percent numberrequired |
Discount percentage available. |
payDays integerrequired |
No. of pay days on which the discount is applicable. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
IMMEDIATE_PAY |
type |
NET |
type |
DAY_OF_MONTH |
type |
DAY_OF_NEXT_MONTH |
PaymentTermModel
{
"id": "5ab20fc8e61c8244807536cb",
"externalId": "10010",
"description": "NET 30",
"name": "NET 30",
"type": "IMMEDIATE_PAY",
"payDays": 0,
"discounts": [
{
"percent": 0.15,
"payDays": 14
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
description string |
Payment term description. Description will be auto generated if not provided based on the payment term details. Ex: If you provide, type as NET, payDays as 30 generated description will be NET 30 |
name stringrequired |
Payment term name. The value of this field should be unique to uniquely identify the records in the transactions. |
type stringrequired |
Available types of Payment Term. Should be one of the following: IMMEDIATE_PAY, NET, DAY_OF_MONTH, DAY_OF_NEXT_MONTH |
payDays integerrequired |
No. of days when the payment will be due. This field is not required when the type is IMMEDIATE_PAY |
discounts [object] |
Discounts available for this payment term. You can specify multiple discounts depending upon your need. |
percent numberrequired |
Discount percentage available. |
payDays integerrequired |
No. of pay days on which the discount is applicable. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
IMMEDIATE_PAY |
type |
NET |
type |
DAY_OF_MONTH |
type |
DAY_OF_NEXT_MONTH |
PlantCodeListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of plant codes. |
Plant Code Model object |
No description |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this plant code for business use. |
description stringrequired |
Description for this plant code. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
This flag indicates whether or not this plant code is available for use. Active true means its available, otherwise not. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
PlantCodeModel
{
"id": "56bdbbee12345bd342cddaa",
"externalId": "10201",
"code": "Plant Code 01",
"description": "PC01",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this plant code for business use. |
description stringrequired |
Description for this plant code. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
This flag indicates whether or not this plant code is available for use. Active true means its available, otherwise not. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
ProfitCenterListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of profit centers. |
Profit Center object |
A representation of the Profit Center |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this profit center for business use. |
name stringrequired |
Name of this profit center for business use. |
description string |
Description for this profit center. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this profit center is active in the system. true means active and false means inactive. Default: false |
validFrom string(date) |
Date from when this profit center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this profit center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
ProfitCenterModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "PC11",
"name": "PC11",
"description": "Profit Center 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": false,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this profit center for business use. |
name stringrequired |
Name of this profit center for business use. |
description string |
Description for this profit center. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this profit center is active in the system. true means active and false means inactive. Default: false |
validFrom string(date) |
Date from when this profit center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this profit center will be available. Date should be in UTC in following format: yyyy-MM-dd. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
ProjectListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of projects |
Project object |
No description |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this project for buisness use. |
name stringrequired |
Name of this project |
description string |
Description for this project. |
active string |
To indicate whether or not this project is active in the system. true means active and false means inactive. |
startDate string(date) |
Date from when this project will be available. Date should be in following format: yyyy-MM-dd. |
endDate string(date) |
Date untill when this project will be available. Date should be in following format: yyyy-MM-dd. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestors [allOf] |
List of Ancestor Projects. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
ProjectModel |
type |
ProjectModel |
type |
ProjectModel |
type |
ClassModel |
ProjectModel
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"code": "P51",
"name": "Project-Elysium",
"description": "Project's was created for some very important reason.",
"active": true,
"startDate": "2025-01-01",
"endDate": "2026-01-29",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"parentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"ancestors": [
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
}
],
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this project for buisness use. |
name stringrequired |
Name of this project |
description string |
Description for this project. |
active string |
To indicate whether or not this project is active in the system. true means active and false means inactive. |
startDate string(date) |
Date from when this project will be available. Date should be in following format: yyyy-MM-dd. |
endDate string(date) |
Date untill when this project will be available. Date should be in following format: yyyy-MM-dd. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
parentRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
ancestors [allOf] |
List of Ancestor Projects. |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
ProjectModel |
type |
ProjectModel |
type |
ProjectModel |
type |
ClassModel |
PurchaseOrderListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of purchase orders. |
Purchase Order object |
A representation of Purchase Order |
id string |
System generated unique identifier for this object. |
externalId string |
External system generated purchase order id to unquiely identify a given purchase order. |
orderNumber string |
Purchase Order’s number. |
orderName string |
Purchase Order’s name. Purchase order names will be picked based on the following conditions. The system will pick the provided value if the order name is provided in the payload. If the order name is NOT provided and the PO has a PR reference, it will use the PR requester name and PO number. Else, it will return an error as the order name is missing. |
orderType stringrequired |
Purchase Order’s type |
docType string |
Purchase Orders’s document type. The system will compute if not provided in the payload as per following logic: 1. MATERIAL → For PR with line item(s) of type PRODUCT Only or PRODUCT and SERVICE mix 2. SERVICE → For PR with line item(s) of type SERVICE only 3. BLANKET → For PR with line item(s) of type BLANKET only 4. INVOICE_PLAN → For PR with line item(s) of type INVOICE_PLAN only 5. MIXED → For all other item type combinations |
goodsReceiptEligible boolean |
This flag will be used to determine whether the Purchase Order is eligible for Goods Receipt or not. If true, the system will flag the PO for goods receipt eligibility and hence the user can create GR document against this PO, and if false is provided, the system will flag the PO for goods receipt ineligibility and hence the user won’t be able to create GR document against this PO. If this flag is not provided, the system will use the default configuration to determine goods receipt eligibility. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
buyerRef object |
Reference to a buyer user. Query the API by id, externalId or docNo to find the buyer user. The API also supports buyer user by providing name & email fields in the reference model. |
id string |
Primary key (ID) of the reference buyer. This id can be used to fetch buyer user. |
externalId string |
Unique identifier for this buyer in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference buyer i.e. username. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced buyer has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the buyer associated with this purchase order. |
email string |
Email of this buyer associated with this purchase order. |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
vatInfo string |
Order’s vatInfo. |
fobTerms string |
Purchase Order’s fobTerms. |
effectiveDate string(date-time) |
Purchase Order’s effective date. |
revisionDate string(date-time) |
Purchase Order’s date of revision. |
issueDate string(date-time)required |
Purchase Order’s date of issue. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
shippingAddress objectrequired |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
billingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
shippingInstructions string |
Instructions for shipping of purchase order. |
notesToSupplier string |
Notes to purchase order’s supplier. |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceComments string |
Comments for invoice of purchase order. |
approvedDate string(date-time) |
Purchase Order’s approved date. |
submittedDate string(date-time) |
Purchase Order’s date of submission. |
supplierConfirmationDate string(date-time) |
Purchase Order’s date when supplier confirm order. |
currency stringrequired |
Purchase order’s currency |
items [allOf] |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
canceledItems [allOf] |
Contains the list of canceled items from the PO. This field is read only. |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
cxmlPayloadId string |
payloadId of purchase order’s cxml. |
goodsReceiptStatus string |
Status of the purchase order’s goodsReceipts. |
vPayment boolean |
Purchase order’s vPayment. When true, this purchase order will always be considered non receivable. |
notesFromSupplier string |
Notes from supplier for the purchase order |
approvalGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poDetailLink string |
Detail link of the purchase order. |
fullyInvoiced boolean |
Indicates if the order is fully invoiced. This field is read only. |
shortClosed boolean |
Indicates if the order is short closed. This field is read only. |
purchaseOrderVersion integer |
Purchase order’s version. This field is read only. |
status string |
Purchase request’s status. This field is read only. |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
readOnly boolean |
This flag can be used to disable PO from being changed in Vroozi application. When true, user will not be able to create POCR for this PO. |
externallySynced boolean |
A flag indicating whether the data is synchronized with the external system. This field is read only. |
acceptExternalPRNumber boolean |
This flag will be used to determine whether system should accept the Purchase Order even if the Purchase Request in the request doesn’t exist in Vroozi. If true, the system will accept the PR number passed in the purchaseRequestRef field even if the PR document doesn’t exist in Vroozi system otherwise a validation error will be thrown. |
metadata object |
Metadata contains a list of errors. This field is read only. |
errors [object] |
No description |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
orderType |
STANDARD |
orderType |
STOCK |
orderType |
BLANKET |
orderType |
INVOICE_PLAN |
docType |
MATERIAL |
docType |
SERVICE |
docType |
BLANKET |
docType |
INVOICE_PLAN |
docType |
MIXED |
type |
PurchaseRequestModel |
type |
SupplierModel |
type |
UserModel |
type |
PaymentTermModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
CompanyCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
goodsReceiptStatus |
NA |
goodsReceiptStatus |
UNCONFIRMED |
goodsReceiptStatus |
CONFIRMED_PARTIAL |
goodsReceiptStatus |
CONFIRMED_FULL |
type |
ApprovalGroupModel |
status |
CANCELED |
status |
CANCELLATION_FAILED |
status |
CONFIRMED |
status |
DISPUTED |
status |
DRAFT |
status |
FAILED |
status |
INVOICED |
status |
ORDERED |
status |
PAID |
status |
PARTIALLY_CONFIRMED |
status |
PARTIALLY_DISPUTED |
status |
PROCESSING |
status |
RECEIVED |
status |
SHIPPED |
status |
SUBMITTED |
PurchaseOrderModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"orderNumber": "2000002699",
"orderName": "GOODS ORDER 2000002699",
"orderType": "STANDARD",
"docType": "MATERIAL",
"goodsReceiptEligible": true,
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"buyerRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "UserModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"email": "buyer@vroozi.com"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"vatInfo": "Vat info",
"fobTerms": "Terms",
"effectiveDate": "2017-06-28T22:05:47.368+0000",
"revisionDate": "2017-06-28T22:05:47.368+0000",
"issueDate": "2017-06-28T22:05:47.368+0000",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"companyAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"billingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"shippingInstructions": "Instructions",
"notesToSupplier": "Notes for supplier",
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"invoiceComments": "Comment",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"supplierConfirmationDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"canceledItems": [
{
"id": "5abbd758e61c824a33ded63a",
"purchaseRequestRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseRequestModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"goodsReceiptRequired": true,
"finalDelivery": false,
"finalInvoice": true,
"status": "CANCELED",
"lineNumber": 1,
"externalItemNumber": "IT10",
"supplierAdditionalData": "SupID",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"cxmlPayloadId": "2000002699.2.1524029208393@vroozi.com",
"goodsReceiptStatus": "CONFIRMED_FULL",
"vPayment": true,
"notesFromSupplier": "notes from supplier",
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false
},
"poDetailLink": "http://vroozi.com/order/",
"fullyInvoiced": true,
"shortClosed": true,
"purchaseOrderVersion": 1,
"status": "ORDERED",
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"readOnly": false,
"externallySynced": false,
"acceptExternalPRNumber": false,
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
External system generated purchase order id to unquiely identify a given purchase order. |
orderNumber string |
Purchase Order’s number. |
orderName string |
Purchase Order’s name. Purchase order names will be picked based on the following conditions. The system will pick the provided value if the order name is provided in the payload. If the order name is NOT provided and the PO has a PR reference, it will use the PR requester name and PO number. Else, it will return an error as the order name is missing. |
orderType stringrequired |
Purchase Order’s type |
docType string |
Purchase Orders’s document type. The system will compute if not provided in the payload as per following logic: 1. MATERIAL → For PR with line item(s) of type PRODUCT Only or PRODUCT and SERVICE mix 2. SERVICE → For PR with line item(s) of type SERVICE only 3. BLANKET → For PR with line item(s) of type BLANKET only 4. INVOICE_PLAN → For PR with line item(s) of type INVOICE_PLAN only 5. MIXED → For all other item type combinations |
goodsReceiptEligible boolean |
This flag will be used to determine whether the Purchase Order is eligible for Goods Receipt or not. If true, the system will flag the PO for goods receipt eligibility and hence the user can create GR document against this PO, and if false is provided, the system will flag the PO for goods receipt ineligibility and hence the user won’t be able to create GR document against this PO. If this flag is not provided, the system will use the default configuration to determine goods receipt eligibility. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
supplierRef objectrequired |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
buyerRef object |
Reference to a buyer user. Query the API by id, externalId or docNo to find the buyer user. The API also supports buyer user by providing name & email fields in the reference model. |
id string |
Primary key (ID) of the reference buyer. This id can be used to fetch buyer user. |
externalId string |
Unique identifier for this buyer in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference buyer i.e. username. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced buyer has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the buyer associated with this purchase order. |
email string |
Email of this buyer associated with this purchase order. |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
vatInfo string |
Order’s vatInfo. |
fobTerms string |
Purchase Order’s fobTerms. |
effectiveDate string(date-time) |
Purchase Order’s effective date. |
revisionDate string(date-time) |
Purchase Order’s date of revision. |
issueDate string(date-time)required |
Purchase Order’s date of issue. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
shippingAddress objectrequired |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
companyAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
billingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
shippingInstructions string |
Instructions for shipping of purchase order. |
notesToSupplier string |
Notes to purchase order’s supplier. |
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceComments string |
Comments for invoice of purchase order. |
approvedDate string(date-time) |
Purchase Order’s approved date. |
submittedDate string(date-time) |
Purchase Order’s date of submission. |
supplierConfirmationDate string(date-time) |
Purchase Order’s date when supplier confirm order. |
currency stringrequired |
Purchase order’s currency |
items [allOf] |
No description |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
canceledItems [allOf] |
Contains the list of canceled items from the PO. This field is read only. |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id stringrequired |
Unique identifier for this object. It’s a required field. |
purchaseRequestRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
goodsReceiptRequired boolean |
Goods Receipt Required |
finalDelivery boolean |
Final Delivery |
finalInvoice boolean |
Final Invoice |
status string |
Line Item Status . CANCELED is supported values for POST requests, other item level statuses are read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
cxmlPayloadId string |
payloadId of purchase order’s cxml. |
goodsReceiptStatus string |
Status of the purchase order’s goodsReceipts. |
vPayment boolean |
Purchase order’s vPayment. When true, this purchase order will always be considered non receivable. |
notesFromSupplier string |
Notes from supplier for the purchase order |
approvalGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
poDetailLink string |
Detail link of the purchase order. |
fullyInvoiced boolean |
Indicates if the order is fully invoiced. This field is read only. |
shortClosed boolean |
Indicates if the order is short closed. This field is read only. |
purchaseOrderVersion integer |
Purchase order’s version. This field is read only. |
status string |
Purchase request’s status. This field is read only. |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
readOnly boolean |
This flag can be used to disable PO from being changed in Vroozi application. When true, user will not be able to create POCR for this PO. |
externallySynced boolean |
A flag indicating whether the data is synchronized with the external system. This field is read only. |
acceptExternalPRNumber boolean |
This flag will be used to determine whether system should accept the Purchase Order even if the Purchase Request in the request doesn’t exist in Vroozi. If true, the system will accept the PR number passed in the purchaseRequestRef field even if the PR document doesn’t exist in Vroozi system otherwise a validation error will be thrown. |
metadata object |
Metadata contains a list of errors. This field is read only. |
errors [object] |
No description |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
dateCreated string |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
orderType |
STANDARD |
orderType |
STOCK |
orderType |
BLANKET |
orderType |
INVOICE_PLAN |
docType |
MATERIAL |
docType |
SERVICE |
docType |
BLANKET |
docType |
INVOICE_PLAN |
docType |
MIXED |
type |
PurchaseRequestModel |
type |
SupplierModel |
type |
UserModel |
type |
PaymentTermModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PurchasingOrganizationModel |
type |
CompanyCodeModel |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
type |
PurchaseRequestModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
CANCELED |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
goodsReceiptStatus |
NA |
goodsReceiptStatus |
UNCONFIRMED |
goodsReceiptStatus |
CONFIRMED_PARTIAL |
goodsReceiptStatus |
CONFIRMED_FULL |
type |
ApprovalGroupModel |
status |
CANCELED |
status |
CANCELLATION_FAILED |
status |
CONFIRMED |
status |
DISPUTED |
status |
DRAFT |
status |
FAILED |
status |
INVOICED |
status |
ORDERED |
status |
PAID |
status |
PARTIALLY_CONFIRMED |
status |
PARTIALLY_DISPUTED |
status |
PROCESSING |
status |
RECEIVED |
status |
SHIPPED |
status |
SUBMITTED |
PurchaseRequestListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of purchase requests. |
Purchase Request object |
A representation of Purchase Request |
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
requestNumber string |
Purchase request’s number. This field is read only. |
name string |
Purchase request’s name. |
requesterRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
powerUserRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
changeRequest boolean |
Determine whether this is a Change Request or a regular Purchase Request. This field is read only. |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approvalGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
channel string |
Channel of this approval groups for business use. |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress objectrequired |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
notesToSupplier string |
Notes to purchase request’s supplier. |
notesToApprover string |
Notes to purchase request’s approver. |
status string |
Purchase request’s status. This field is read only. |
docType string |
Purchase Request’s document type. The system will compute if not provided in the payload as per following logic: 1. MATERIAL → For PR with line item(s) of type PRODUCT Only or PRODUCT and SERVICE mix 2. SERVICE → For PR with line item(s) of type SERVICE only 3. BLANKET → For PR with line item(s) of type BLANKET only 4. INVOICE_PLAN → For PR with line item(s) of type INVOICE_PLAN only 5. MIXED → For all other item type combinations |
reasonForRequest string |
Reason for request of the purchase request. |
approverComments string |
Comments of purchase request’s approver. |
rejectionCode string |
Purchase request’s rejection code. This field is read only. |
approvalCode string |
Purchase request’s approval code. This field is read only. |
reasonForReject string |
Reason for reject of the purchase request. This field is read only. |
approvedDate string(date-time) |
Purchase request’s approved date. This field is read only. |
rejectedDate string(date-time) |
Purchase request’s rejected date. This field is read only. |
submittedDate string(date-time) |
Purchase request’s submitted date. This field is read only. |
currency string |
Purchase request’s currency |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
items [allOf] |
List of Line Items |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id string |
System generated unique identifier for this object. This field is read only. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
catalogRef object |
Reference to a catalog object. The system will automatically populate it if value is not specified explicitly. |
id string |
Primary key (ID) of the reference data model. |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
Name of this catalog as defined in Catalog configuration in SmartOCI. |
type string |
Type of the Reference object |
label string |
Label displays Catalog Type with the Catalog Name in the following format. Catalog Type - Catalog Name. |
archived boolean |
This flag indicates whether the referenced catalog has been archived. If true, this object cannot be retrieve or used for future reference. |
clientCatalogId string |
This field represents the client specified Catalog ID in catalog configuration in SmartOCI. |
supplierAdditionalData string |
Additional data of purchase request’s supplier. |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
approvedDate string(date-time) |
Purchase Order’s approved date. This field is read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
copiedFrom string |
Request number of request copied. This field is read only. |
forwardedOn string(date-time) |
Purchase request’s forwarded date. This field is read only. |
metadata object |
Metadata contains a list of errors. This field is read only. |
errors [object] |
No description |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
Enumerated Values
| Property | Value |
|---|---|
type |
UserModel |
type |
UserModel |
type |
PurchaseOrderModel |
type |
ApprovalGroupModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
DRAFT |
status |
PENDING |
status |
SOURCING_REVIEW |
status |
APPROVED |
status |
REJECTED |
status |
CANCELED |
docType |
MATERIAL |
docType |
SERVICE |
docType |
BLANKET |
docType |
INVOICE_PLAN |
docType |
MIXED |
type |
SupplierModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
PurchaseRequestModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"requestNumber": "2000002699",
"name": "2000002699",
"requesterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"powerUserRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"changeRequest": true,
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"approvalGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ApprovalGroupModel",
"label": "Description for label",
"archived": false,
"channel": "CHA-1"
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"notesToSupplier": "Notes for supplier",
"notesToApprover": "Notes for approver",
"status": "REJECTED",
"docType": "MATERIAL",
"reasonForRequest": "Request reason",
"approverComments": "Approver comments",
"rejectionCode": "Instructions",
"approvalCode": "Terms",
"reasonForReject": "standard",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000",
"currency": "USD",
"subTotal": "200",
"taxAmount": "20",
"shippingCharges": "10",
"totalAmount": "2002.43",
"items": [
{
"id": "5abbd758e61c824a33ded63a",
"supplierRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
},
"catalogRef": {
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "CatalogModel",
"label": "1 - ABC Catalog",
"archived": false,
"clientCatalogId": "ext-catalog"
},
"supplierAdditionalData": "SupID",
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"name": "Default Address",
"attentionTo": "John Smith",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "+1 (201) 555-5555",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"approvedDate": "2017-06-28T22:05:47.368+0000",
"lineNumber": 1,
"externalItemNumber": "IT10",
"type": "PRODUCT",
"category": "category",
"description": "Sample description",
"longDescription": "Sample long description",
"freeItem": true,
"unitPrice": 10.2,
"priceUnit": 1,
"currency": "USD",
"quantity": 2.5,
"subTotal": 25.5,
"totalPrice": 48.1,
"invoicePlanAmount": 22.5,
"uom": "EA",
"deliveryDate": "2017-06-28T22:22:22.000+0000",
"partNo": "PNO12345",
"quote": "quote",
"manufacturerPartNo": "MPNO123",
"brandName": "Sample Brand Name",
"manufacturerName": "Sample Manufacturer Name",
"notes": "Sample notes",
"accountDistributionType": "percent",
"accountDistributionList": [
{
"costObjectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false,
"profitCenter": "sample profit center"
},
"glAccountRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GlAccountModel",
"label": "Description for label",
"archived": false
},
"customerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CustomerModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"budgetRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BudgetModel",
"label": "Description for label",
"archived": false
},
"profitCenter": "PC001",
"charge": "100",
"splitPercent": "40",
"distributedAmount": 10,
"distributedTax": 20,
"distributedShippingCharges": 25,
"distributedTotalAmount": 30,
"distributedUseTax": 30,
"distributedDiscountAmount": 15
}
],
"taxAmount": 20.3,
"shippingCharges": 2.3,
"dateCreated": "2017-06-28T22:05:47.368+0000",
"lastUpdated": "2017-06-28T22:05:47.368+0000",
"buyerGroupRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "BuyerGroupModel",
"label": "Description for label",
"archived": false
},
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"purchasingOrgRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchasingOrganizationModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"itemDetailUrl": "www.vroozi.com",
"taxCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "TaxCodeModel",
"label": "Description for label",
"archived": false
},
"taxPercentage": 9.5,
"agreement": "Agreement Text",
"agreementItemNumber": "1001",
"externalRequestItemNumber": "10010",
"dynamicFields": [
{
"name": "Field Name",
"value": "Field Value"
}
],
"validFrom": "2017-06-28T22:22:22.000+0000",
"validTo": "2017-07-28T22:22:22.000+0000",
"serviceStartDate": "2017-08-28T22:22:22.000+0000",
"serviceEndDate": "2017-09-28T22:22:22.000+0000",
"expectedValue": 12.4,
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"catalogItem": true,
"externalCatalogItemId": "U78244",
"catalogItemId": "45546",
"listPrice": 10.2,
"changeActionStatus": "ADD"
}
],
"copiedFrom": "1000005594",
"forwardedOn": "2017-06-28T22:05:47.368+0000",
"metadata": {
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"attachments": [
{
"id": "5a3bd758e61c824a33ded63a",
"name": "image.jpg",
"size": "16630",
"primary": "true"
}
],
"customFields": [
{
"name": "color id",
"displayName": "Color ID",
"value": "11001",
"additionalPrice": "string",
"dynamicPartNo": "-REGENCY",
"includeInPO": true
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
requestNumber string |
Purchase request’s number. This field is read only. |
name string |
Purchase request’s name. |
requesterRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
powerUserRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
changeRequest boolean |
Determine whether this is a Change Request or a regular Purchase Request. This field is read only. |
purchaseOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
approvalGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
channel string |
Channel of this approval groups for business use. |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress objectrequired |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
notesToSupplier string |
Notes to purchase request’s supplier. |
notesToApprover string |
Notes to purchase request’s approver. |
status string |
Purchase request’s status. This field is read only. |
docType string |
Purchase Request’s document type. The system will compute if not provided in the payload as per following logic: 1. MATERIAL → For PR with line item(s) of type PRODUCT Only or PRODUCT and SERVICE mix 2. SERVICE → For PR with line item(s) of type SERVICE only 3. BLANKET → For PR with line item(s) of type BLANKET only 4. INVOICE_PLAN → For PR with line item(s) of type INVOICE_PLAN only 5. MIXED → For all other item type combinations |
reasonForRequest string |
Reason for request of the purchase request. |
approverComments string |
Comments of purchase request’s approver. |
rejectionCode string |
Purchase request’s rejection code. This field is read only. |
approvalCode string |
Purchase request’s approval code. This field is read only. |
reasonForReject string |
Reason for reject of the purchase request. This field is read only. |
approvedDate string(date-time) |
Purchase request’s approved date. This field is read only. |
rejectedDate string(date-time) |
Purchase request’s rejected date. This field is read only. |
submittedDate string(date-time) |
Purchase request’s submitted date. This field is read only. |
currency string |
Purchase request’s currency |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
items [allOf] |
List of Line Items |
allOf
| Name | Description |
|---|---|
anonymous object |
A Representation of a Purchase Order lineitem |
id string |
System generated unique identifier for this object. This field is read only. |
supplierRef object |
Reference to a supplier object. Query the API by id, externalId or docNo to find the supplier object. The API also supports fetching of supplier object by providing vendorId. If there are multiple records by the same vendorId than system will give error. To resolve this error one can provide name & vendorId fields collectively in the reference model. |
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
catalogRef object |
Reference to a catalog object. The system will automatically populate it if value is not specified explicitly. |
id string |
Primary key (ID) of the reference data model. |
externalId string |
Primary key (ID) of the reference data model in external system. |
docNo string |
Name of this catalog as defined in Catalog configuration in SmartOCI. |
type string |
Type of the Reference object |
label string |
Label displays Catalog Type with the Catalog Name in the following format. Catalog Type - Catalog Name. |
archived boolean |
This flag indicates whether the referenced catalog has been archived. If true, this object cannot be retrieve or used for future reference. |
clientCatalogId string |
This field represents the client specified Catalog ID in catalog configuration in SmartOCI. |
supplierAdditionalData string |
Additional data of purchase request’s supplier. |
shippingAddress object |
A representation of address |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
name stringrequired |
Unique Name of the identifying the address. |
attentionTo string |
Name of the person or business |
addressType [string]required |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
The phone field is used to store a valid phone number, which must be prefixed with a country code and area code. For example phone number in the following format “+81 044 123 45 67”. |
active boolean |
Defines if address is active or not. true if its active, false if its not active. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
approvedDate string(date-time) |
Purchase Order’s approved date. This field is read only. |
and
| Name | Description |
|---|---|
anonymous object |
A representation of an line item |
lineNumber integer |
The line number with in the current document. This field is read only. |
externalItemNumber string |
External Item number |
supplierAdditionalData string |
Additional data to identify the item uniquely in supplier system |
type stringrequired |
Type |
category stringrequired |
Category |
description stringrequired |
Description |
longDescription string |
Long Description |
freeItem boolean |
Free Item |
unitPrice numberrequired |
Unit Price |
priceUnit integer |
Price Unit |
currency stringrequired |
Currency |
quantity numberrequired |
Quantity |
subTotal number |
Sub Total |
totalPrice number |
Total Price |
invoicePlanAmount number |
Invoice Plan Amount |
uom stringrequired |
Unit of Measure |
deliveryDate string(date) |
Delivery Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
partNo string |
Part No. |
quote string |
Quote |
manufacturerPartNo string |
Manufacturer Part No. |
brandName string |
Brand Name |
manufacturerName string |
Manufacturer Name |
notes string |
Notes |
accountDistributionType stringrequired |
Account Distribution Type |
accountDistributionList [object] |
No description |
costObjectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
profitCenter string |
Profit center associated with the cost object. This field is read only. |
type any |
No description |
continued
| Name | Description |
|---|---|
glAccountRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
customerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCenter string |
Profit Center |
charge number |
Charge |
splitPercent number |
Split Percent |
distributedAmount number |
Distributed Amount |
distributedTax number |
Distributed Tax |
distributedShippingCharges number |
Distributed Shipping Charges |
distributedTotalAmount number |
Distributed Total Amount |
distributedUseTax number |
Distributed Use Tax |
distributedDiscountAmount number |
Distributed Discount |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
dateCreated string(date-time) |
Date Created. This field is read only. |
lastUpdated string(date-time) |
Last Updated. This field is read only. |
buyerGroupRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
purchasingOrgRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
itemDetailUrl string |
Item Detail URL |
taxCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxPercentage number |
Tax Percentage |
agreement string |
Agreement |
agreementItemNumber string |
Agreement Item Number |
externalRequestItemNumber string |
External Request Item Number |
dynamicFields [object] |
No description |
Dynamic Field object |
A representation of Dynamic Field |
name string |
Name |
value string |
Value |
validFrom string(date-time) |
Valid From > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
validTo string(date-time) |
Valid To > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceStartDate string(date-time) |
Service Start Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
serviceEndDate string(date-time) |
Service End Date > - Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
expectedValue number |
Expected Value |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
catalogItem boolean |
Is this a catalog item. This field is read only. |
externalCatalogItemId string |
Field contains Catalog Item Id (SKU). This field is read only for Purchase Orders and can be used to identify the catalog item in Purchase Request documents. |
catalogItemId string |
Internal Catalog Item Id This field is read only. |
listPrice number |
Item List Price |
changeActionStatus string |
Shows the action performed on particular line item in case of change request during the POCR. This field is read only. |
copiedFrom string |
Request number of request copied. This field is read only. |
forwardedOn string(date-time) |
Purchase request’s forwarded date. This field is read only. |
metadata object |
Metadata contains a list of errors. This field is read only. |
errors [object] |
No description |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
attachments [object] |
Array of attachments. |
Attachment object |
A representation of the Attachment |
id string |
System generated unique identifier for this object. |
name string |
File name |
size number |
Size of Attachment in bytes |
primary boolean |
Whether this attachment is the primary attachment for the document |
customFields [object] |
Listing of Custom Fields |
name string |
Name of the custom field |
displayName string |
An optionally provided name of the custom field that can be different from the name |
value string |
Value of the custom field |
additionalPrice string |
Additional Price example: “0” |
dynamicPartNo string |
Dynamic Part No |
includeInPO boolean |
This flag indicate whether or not this custom field should be included in the Purchase Order submitted to a supplier. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
Enumerated Values
| Property | Value |
|---|---|
type |
UserModel |
type |
UserModel |
type |
PurchaseOrderModel |
type |
ApprovalGroupModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
status |
DRAFT |
status |
PENDING |
status |
SOURCING_REVIEW |
status |
APPROVED |
status |
REJECTED |
status |
CANCELED |
docType |
MATERIAL |
docType |
SERVICE |
docType |
BLANKET |
docType |
INVOICE_PLAN |
docType |
MIXED |
type |
SupplierModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
PRODUCT |
type |
SERVICE |
type |
INVOICE_PLAN |
type |
BLANKET |
accountDistributionType |
none |
accountDistributionType |
percent |
accountDistributionType |
quantity |
accountDistributionType |
value |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
GlAccountModel |
type |
CustomerModel |
type |
CompanyCodeModel |
type |
ClassModel |
type |
ProjectModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CompanyCodeModel |
type |
PurchasingOrganizationModel |
type |
PlantCodeModel |
type |
TaxCodeModel |
changeActionStatus |
ADD |
changeActionStatus |
CANCEL |
changeActionStatus |
DELETE |
changeActionStatus |
EDIT |
PurchaseRequestStatusListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.55,
"taxAmount": 20.56,
"shippingCharges": 10.12,
"totalAmount": 2002.43,
"itemsCount": 2,
"requestNumber": "2000002699",
"name": "2000002699",
"status": "REJECTED",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of purchase requests summary. |
Purchase Request Summary object |
A representation of Purchase Request Summary |
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
requestNumber string |
Purchase request’s number. This field is read only. |
name string |
Purchase request’s name. |
status string |
Purchase request’s summary. This field is read only. |
approvedDate string(date-time) |
Purchase request’s approved date. This field is read only. |
rejectedDate string(date-time) |
Purchase request’s rejected date. This field is read only. |
submittedDate string(date-time) |
Purchase request’s submitted date. This field is read only. |
Enumerated Values
| Property | Value |
|---|---|
status |
PENDING |
status |
SOURCING_REVIEW |
status |
APPROVED |
status |
REJECTED |
PurchaseRequestStatusModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1232123",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"subTotal": 200.55,
"taxAmount": 20.56,
"shippingCharges": 10.12,
"totalAmount": 2002.43,
"itemsCount": 2,
"requestNumber": "2000002699",
"name": "2000002699",
"status": "REJECTED",
"approvedDate": "2017-06-28T22:05:47.368+0000",
"rejectedDate": "2017-06-28T22:05:47.368+0000",
"submittedDate": "2017-06-28T22:05:47.368+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. This field is read only. |
externalId string |
External system generated payment id to unquiely identify a given payment. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. This field is read only. |
subTotal number |
Subtotal. This field is read only. |
taxAmount number |
Tax Amount |
shippingCharges number |
Shipping Charges |
totalAmount number |
Total Amount. This field is read only. |
itemsCount integer |
List of Line Items |
requestNumber string |
Purchase request’s number. This field is read only. |
name string |
Purchase request’s name. |
status string |
Purchase request’s summary. This field is read only. |
approvedDate string(date-time) |
Purchase request’s approved date. This field is read only. |
rejectedDate string(date-time) |
Purchase request’s rejected date. This field is read only. |
submittedDate string(date-time) |
Purchase request’s submitted date. This field is read only. |
Enumerated Values
| Property | Value |
|---|---|
status |
PENDING |
status |
SOURCING_REVIEW |
status |
APPROVED |
status |
REJECTED |
PurchaseRequestSubmissionModel
{
"approverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"souringReviewerRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
}
}
Properties
| Name | Description |
|---|---|
approverRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
souringReviewerRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
UserModel |
type |
UserModel |
PurchasingOrganizationListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of Purchasing Organizations. |
Purchasing Organization object |
A representation of the Purchasing Organization |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this purchasing organization for business use. |
description stringrequired |
Description for this purchasing organization. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this purchasing organization is active in the system. true means active and false means inactive. Default: true |
validFrom string(date) |
Date from when this purchasing organization will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this purchasing organization will be available. Date should be in UTC in following format: yyyy-MM-dd. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
PurchasingOrganizationModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "100",
"code": "CC11",
"description": "Purchasing Organization 11",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"active": true,
"validFrom": "2017-06-28",
"validTo": "2017-06-28",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this purchasing organization for business use. |
description stringrequired |
Description for this purchasing organization. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active boolean |
To indicate whether or not this purchasing organization is active in the system. true means active and false means inactive. Default: true |
validFrom string(date) |
Date from when this purchasing organization will be available. Date should be in UTC in following format: yyyy-MM-dd. |
validTo string(date) |
Date until when this purchasing organization will be available. Date should be in UTC in following format: yyyy-MM-dd. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
ReceiptCancelModel
{
"externalId": "11001",
"docNo": "CC01",
"goodsReceiptRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "GoodsReceiptModel",
"label": "Description for label",
"archived": false
},
"userRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"postingDate": "2017-06-28T22:05:47.368+0000",
"rmaNumber": "2736384",
"billOfLading": "bill",
"packingSlip": "packing",
"comments": "Cancelling a Goods Receipt 000001",
"items": [
{
"id": "3730",
"poLineNumber": 1,
"poLineItemId": "1"
}
]
}
Properties
| Name | Description |
|---|---|
externalId string |
Primary key (ID) of the Goods Receipt data model in the external system. |
docNo string |
Document Number |
goodsReceiptRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
userRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
postingDate string(date-time) |
Posting Date |
rmaNumber string |
GoodsReceipt’s rmaNumber. |
billOfLading string |
GoodsReceipt’s bill of lading. |
packingSlip string |
GoodsReceipt’s packing slip. |
comments string |
Comments |
items [object] |
No description |
id string |
System generated unique identifier for this object (Read only). |
poLineNumber integer |
No description |
poLineItemId string |
No description |
Enumerated Values
| Property | Value |
|---|---|
type |
GoodsReceiptModel |
type |
UserModel |
ReferenceDataListModel
[
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
]
Properties
| Name | Description |
|---|---|
List of References. [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
ReferenceDataModel
{
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
}
Properties
| Name | Description |
|---|---|
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. |
Enumerated Values
| Property | Value |
|---|---|
type |
AddressModel |
type |
ApprovalGroupModel |
type |
BudgetModel |
type |
BuyerGroupModel |
type |
CatalogItemModel |
type |
CatalogModel |
type |
ClassModel |
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
CustomerModel |
type |
GlAccountModel |
type |
GoodsReceiptModel |
type |
InternalOrderModel |
type |
InvoiceModel |
type |
LocationModel |
type |
LocationTypeModel |
type |
PaymentModel |
type |
PaymentRequestModel |
type |
PaymentTermModel |
type |
PlantCodeModel |
type |
ProfitCenterModel |
type |
ProjectModel |
type |
PurchaseOrderModel |
type |
PurchaseRequestModel |
type |
PurchasingOrganizationModel |
type |
SupplierModel |
type |
TaxCodeModel |
type |
UserModel |
type |
WBSElementModel |
type |
ContentViewModel |
type |
ContentGroupModel |
ShortCloseModel
{
"purchaseOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PurchaseOrderModel",
"label": "Description for label",
"archived": false
},
"shortCloseFor": "RECEIVING"
}
Properties
| Name | Description |
|---|---|
purchaseOrderRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shortCloseFor stringrequired |
Identifier for the PO to be short closed for receiving or invoicing. |
Enumerated Values
| Property | Value |
|---|---|
type |
PurchaseOrderModel |
shortCloseFor |
RECEIVING |
shortCloseFor |
INVOICING |
StatusUpdateRequestModel
{
"budgetRefs": [
{
"type": "BudgetModel"
}
],
"active": true
}
Properties
| Name | Description |
|---|---|
budgetRefs anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
active booleanrequired |
Indicates whether or not this budget is active in the system. true means active and false means inactive. |
Enumerated Values
| Property | Value |
|---|---|
type |
BudgetModel |
SupplierListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of suppliers. |
Supplier object |
A representation of the supplier |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
uniqueId string |
Unique Supplier ID. |
name stringrequired |
The name of the company associated with this supplier. |
vendorId stringrequired |
Business ID of this supplier in the Vendor Master Data |
fax string |
Fax Number of this supplier |
displayName string |
The name of the vendor as displayed. |
website string |
URL of supplier website |
federalTaxId string |
The federal tax id from the external system/client. |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
bankInfo object |
A representation of bank account info. When any of the field has some value provided, this object is required, and we validate the required fields, otherwise this is not a require object. |
bankKey stringrequired |
Bank Key |
bankName stringrequired |
Bank Name |
bankAccountNumber stringrequired |
Bank’s provided account number |
accountHolderName stringrequired |
Account holder’s name |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
bankControlKey string |
Bank Control Key |
partnerBankType string |
Partner Bank Type |
bankBranch string |
Bank Branch |
swiftBic string |
Swift bic |
subjectToWht boolean |
This flag indicates whether supplier is subject to wht or not. true means that supplier is subject to withholding tax. false means that supplier is not subject to withholding tax. |
withholdingTaxDetails object |
A representation of withholding tax details when withholding tax configuration is enabled |
whtCode string |
Withholding tax code |
whtType string |
Withholding tax type |
supplierAttributes [object] |
List of supplier attributes |
Supplier Attribute Model object |
Supplier Attribute |
name string |
Supplier Attribute Name |
description string |
Supplier Attribute Description |
active boolean |
Read Only: To indicate whether or not this supplier attribute is active in the system. true means active and false means inactive. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
currencyCode string |
Currency Code used by supplier. CurrencyCode should be three character code. Ex: USD for US Dollars. |
type [string] |
Type of the supplier. Possible values: Catalog or NonCatalog. [Catalog] means that this supplier only supports catalog items. [NonCatalog] means this supplier only supports non-catalog items. [Catalog,NonCatalog] means this supplier supports both catalog and non-catalog items. Default: [Catalog, NonCatalog] |
outputMethod string |
Output method indicates the method of Purchase Order submission to this supplier. Possible values: email, edi, cxml or supplier_portal. If email, the Purchase Order will be sent via email in PDF format.outputEmail should be provided if email is used. If edi, the Purchase Order will be sent via SFTP in EDI format. If cxml, the Purchase Order will be sent via http post in cxml format. poCxmlDetails should be provided if cxml is used. If supplier_portal, the Purchase Order will be sent via the Supplier Portal and the access to it will be granted if needed. When no Output method is provided, then value will be null and the supplier won’t have a submission channel. |
outputEmail string |
Supplier email address where the purchase order will be sent outputMethod should be set to email for this. |
poCxmlDetails object |
cXML Details for cXML transactions |
name string |
Name of cXML Settings. Example: Default. |
fromDomain string |
From Domain for cXML request. Example: NetworkId or DUNS. |
fromIdentity string |
From Identity for cXML request. Example: Value for NetworkId or DUNS. |
toDomain string |
To Domain for cXML request. Example: NetworkId or DUNS. |
toIdentity string |
To Identity for cXML request. Example: Value for the NetworkId or DUNS |
senderDomain string |
Sender Domain for cXML request. Example: NetworkId or DUNS |
senderIdentity string |
Sender Identify for cXML request. Example: Username |
sharedSecret string |
Sender sharedSecret for cXML request. Example: Password |
orderSubmissionUrl string |
Supplier URL for accepting cXML Purchase Order |
active boolean |
Active status of cXML Setting. |
invoiceCxmlSupported boolean |
This flag indicates whether supplier is able to send invoice via cXML. true means supplier supports cXML invoice, false means supplier doesnt support cXML invoice. Default: false |
invoiceCxmlDetails object |
cXML Details for cXML transactions |
name string |
Name of cXML Settings. Example: Default. |
fromDomain string |
From Domain for cXML request. Example: NetworkId or DUNS. |
fromIdentity string |
From Identity for cXML request. Example: Value for NetworkId or DUNS. |
toDomain string |
To Domain for cXML request. Example: NetworkId or DUNS. |
toIdentity string |
To Identity for cXML request. Example: Value for the NetworkId or DUNS |
senderDomain string |
Sender Domain for cXML request. Example: NetworkId or DUNS |
senderIdentity string |
Sender Identify for cXML request. Example: Username |
sharedSecret string |
Sender sharedSecret for cXML request. Example: Password |
orderSubmissionUrl string |
Supplier URL for accepting cXML Purchase Order |
active boolean |
Active status of cXML Setting. |
goodsReceiptRequired boolean |
This flag indicates whether or not this supplier requires goods receipt. If true, purchase order for this supplier requires goods receipt for amount above the threshold amount. If false, purchase order for this supplier dont require goods receipt. Default: true |
goodsReceiptThresholdAmount number |
Good receipt threshold amount. This is only effective if the supplier enable goodsReceiptRequired flag. See goodsReceiptRequired field for more detail. Default: 0 |
poAckSupported boolean |
This flag indicates whether supplier can send acknowledgment for Purchase Order. true means that supplier can send acknowledgment for Purchase Order. false means that supplier cannot send acknowledgment for Purchase Order. Default: false |
allowCxmlOrderConfirmation boolean |
Is used to enable the supplier to send Order Confirmation via cXML. true means that supplier can send Order Confirmation via cXML. false means that supplier cannot send Order Confirmation via cXML. |
allowCxmlAdvanceShippingNotice boolean |
Is used to enable the supplier to send Ship Notice via cXML. true means that supplier can send Ship Notice via cXML. false means that supplier cannot send Ship Notice via cXML. |
leadTimeFrequency string |
Frequency of the Lead Time. Possible values: NO_DELIVERY_DATE, NO_OF_DAYS, NO_OF_WEEKS, NO_OF_MONTHS. If NO_DELIVERY_DATE is set, delivery date will not be sent in the purchase order cXML, if any other value is specified, the lead time value will be calculated based on the frequency specified |
leadTimeValue integer |
This field is used to calculate the expected delivery date based on the lead time frequency. |
active boolean |
Indicates whether or not this supplier is active in the system. true means active and false means inactive. |
poAttachmentsAllowed boolean |
Indicates whether or not this supplier is allowed for PO attachments true means attachments are supported and false means attachments are not supported. |
enableTaxAmount boolean |
Indicates whether or not this supplier supports tax amount true means tax amount is supported in cxml and false means not supported. |
partIdLineIdentifier boolean |
Part Id identified configuration which enable supplier to have this data supported in supplier cxml. |
advancedShipmentNoticeEnabled boolean |
Advanced Notice Shipment toggle which enable supplier to have ASN feature enabled. |
administrativeNotes string |
Administrative notes for this supplier. |
includeSupplierCard boolean |
Includes supplier card toggle which enable supplier card. |
singleSourceSupplier boolean |
Indicates whether this supplier is single source or not. |
automaticPRApproval boolean |
Indicates whether this supplier supports auto PR approvals. This field can be used with Single source supplier when set to true. |
autoApprovalThreshold number |
Auto approval threshold set for this supplier. This field can be used with Single source supplier when set to true |
minimumOrderValue number |
Minimum order quantity that this supplier supports. |
ersEnabled boolean |
Indicates whether this supplier supports ERS. |
sdmSupplier boolean |
Indicates whether this supplier is an SDM supplier. |
poChangeRequest boolean |
Indicates whether this supplier supports POCR. |
disableBrowse boolean |
Indicates whether this supplier is browsable in SDM. |
contacts [object] |
No description |
Contact Details object |
Contact Details of supplier |
id string |
id is optional field, if provided in the payload it will be saved, otherwise system generated id will be saved. This field should be unique in the given supplier. |
name string |
Name given to a contact. |
email string |
Email used by this contact. |
phone string |
Phone number of this contact. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
logo string |
Stores Id of supplier logo uploaded on S3. |
language string |
The language of the supplier as two uppercase characters Default: EN |
poNotificationEmails [string] |
Set of unique email addresses for receiving PO notifications |
Enumerated Values
| Property | Value |
|---|---|
type |
PaymentTermModel |
type |
CompanyCodeModel |
language |
EN |
language |
EN_GB |
language |
EN_NZ |
language |
IT |
language |
JA |
language |
NO |
language |
SV |
SupplierModel
{
"id": "5abbd758e61c824a33ded63a",
"externalId": "1110",
"uniqueId": "123456",
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"fax": "214-5234566",
"displayName": "Vroozi",
"website": "www.vroozi.com",
"federalTaxId": "123432123",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
},
"paymentTermRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentTermModel",
"label": "Description for label",
"archived": false
},
"bankInfo": {
"bankKey": "SCB",
"bankName": "Standard Chartered Bank",
"bankAccountNumber": "123456-1",
"accountHolderName": "John",
"country": {
"name": "United States of America",
"code": "US"
},
"bankControlKey": "01",
"partnerBankType": "Commercial",
"bankBranch": "Main branch CA",
"swiftBic": "Swift bic"
},
"subjectToWht": true,
"withholdingTaxDetails": {
"whtCode": "J1",
"whtType": "Z1"
},
"supplierAttributes": [
{
"name": "Green certified",
"description": "Green certified- Preferred",
"active": true
}
],
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"currencyCode": "USD",
"type": [
"Catalog",
"NonCatalog"
],
"outputMethod": "email",
"outputEmail": "supplier@vroozi.com",
"poCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"invoiceCxmlSupported": true,
"invoiceCxmlDetails": {
"name": "Default",
"fromDomain": "NetworkId",
"fromIdentity": "Vroozi",
"toDomain": "NetworkId",
"toIdentity": "Supplier",
"senderDomain": "NetworkId",
"senderIdentity": "username",
"sharedSecret": "password",
"orderSubmissionUrl": "https://supplier.vroozi.com/invoke/ordersubmission/url",
"active": true
},
"goodsReceiptRequired": false,
"goodsReceiptThresholdAmount": 1000,
"poAckSupported": true,
"allowCxmlOrderConfirmation": true,
"allowCxmlAdvanceShippingNotice": true,
"leadTimeFrequency": "NO_DELIVERY_DATE",
"leadTimeValue": 10,
"active": true,
"poAttachmentsAllowed": true,
"enableTaxAmount": false,
"partIdLineIdentifier": true,
"advancedShipmentNoticeEnabled": true,
"administrativeNotes": "Some text as notes",
"includeSupplierCard": false,
"singleSourceSupplier": true,
"automaticPRApproval": true,
"autoApprovalThreshold": 1000,
"minimumOrderValue": 10,
"ersEnabled": true,
"sdmSupplier": true,
"poChangeRequest": true,
"disableBrowse": true,
"contacts": [
{
"id": "5abbd758e61c824a33ded63a",
"name": "Person Name",
"email": "contact@vroozi.com",
"phone": "17182828222"
}
],
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"logo": "5b695cda5711ba4efc8be5d7",
"language": "JA",
"poNotificationEmails": [
"string"
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
uniqueId string |
Unique Supplier ID. |
name stringrequired |
The name of the company associated with this supplier. |
vendorId stringrequired |
Business ID of this supplier in the Vendor Master Data |
fax string |
Fax Number of this supplier |
displayName string |
The name of the vendor as displayed. |
website string |
URL of supplier website |
federalTaxId string |
The federal tax id from the external system/client. |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
paymentTermRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
bankInfo object |
A representation of bank account info. When any of the field has some value provided, this object is required, and we validate the required fields, otherwise this is not a require object. |
bankKey stringrequired |
Bank Key |
bankName stringrequired |
Bank Name |
bankAccountNumber stringrequired |
Bank’s provided account number |
accountHolderName stringrequired |
Account holder’s name |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
bankControlKey string |
Bank Control Key |
partnerBankType string |
Partner Bank Type |
bankBranch string |
Bank Branch |
swiftBic string |
Swift bic |
subjectToWht boolean |
This flag indicates whether supplier is subject to wht or not. true means that supplier is subject to withholding tax. false means that supplier is not subject to withholding tax. |
withholdingTaxDetails object |
A representation of withholding tax details when withholding tax configuration is enabled |
whtCode string |
Withholding tax code |
whtType string |
Withholding tax type |
supplierAttributes [object] |
List of supplier attributes |
Supplier Attribute Model object |
Supplier Attribute |
name string |
Supplier Attribute Name |
description string |
Supplier Attribute Description |
active boolean |
Read Only: To indicate whether or not this supplier attribute is active in the system. true means active and false means inactive. |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
currencyCode string |
Currency Code used by supplier. CurrencyCode should be three character code. Ex: USD for US Dollars. |
type [string] |
Type of the supplier. Possible values: Catalog or NonCatalog. [Catalog] means that this supplier only supports catalog items. [NonCatalog] means this supplier only supports non-catalog items. [Catalog,NonCatalog] means this supplier supports both catalog and non-catalog items. Default: [Catalog, NonCatalog] |
outputMethod string |
Output method indicates the method of Purchase Order submission to this supplier. Possible values: email, edi, cxml or supplier_portal. If email, the Purchase Order will be sent via email in PDF format.outputEmail should be provided if email is used. If edi, the Purchase Order will be sent via SFTP in EDI format. If cxml, the Purchase Order will be sent via http post in cxml format. poCxmlDetails should be provided if cxml is used. If supplier_portal, the Purchase Order will be sent via the Supplier Portal and the access to it will be granted if needed. When no Output method is provided, then value will be null and the supplier won’t have a submission channel. |
outputEmail string |
Supplier email address where the purchase order will be sent outputMethod should be set to email for this. |
poCxmlDetails object |
cXML Details for cXML transactions |
name string |
Name of cXML Settings. Example: Default. |
fromDomain string |
From Domain for cXML request. Example: NetworkId or DUNS. |
fromIdentity string |
From Identity for cXML request. Example: Value for NetworkId or DUNS. |
toDomain string |
To Domain for cXML request. Example: NetworkId or DUNS. |
toIdentity string |
To Identity for cXML request. Example: Value for the NetworkId or DUNS |
senderDomain string |
Sender Domain for cXML request. Example: NetworkId or DUNS |
senderIdentity string |
Sender Identify for cXML request. Example: Username |
sharedSecret string |
Sender sharedSecret for cXML request. Example: Password |
orderSubmissionUrl string |
Supplier URL for accepting cXML Purchase Order |
active boolean |
Active status of cXML Setting. |
invoiceCxmlSupported boolean |
This flag indicates whether supplier is able to send invoice via cXML. true means supplier supports cXML invoice, false means supplier doesnt support cXML invoice. Default: false |
invoiceCxmlDetails object |
cXML Details for cXML transactions |
name string |
Name of cXML Settings. Example: Default. |
fromDomain string |
From Domain for cXML request. Example: NetworkId or DUNS. |
fromIdentity string |
From Identity for cXML request. Example: Value for NetworkId or DUNS. |
toDomain string |
To Domain for cXML request. Example: NetworkId or DUNS. |
toIdentity string |
To Identity for cXML request. Example: Value for the NetworkId or DUNS |
senderDomain string |
Sender Domain for cXML request. Example: NetworkId or DUNS |
senderIdentity string |
Sender Identify for cXML request. Example: Username |
sharedSecret string |
Sender sharedSecret for cXML request. Example: Password |
orderSubmissionUrl string |
Supplier URL for accepting cXML Purchase Order |
active boolean |
Active status of cXML Setting. |
goodsReceiptRequired boolean |
This flag indicates whether or not this supplier requires goods receipt. If true, purchase order for this supplier requires goods receipt for amount above the threshold amount. If false, purchase order for this supplier dont require goods receipt. Default: true |
goodsReceiptThresholdAmount number |
Good receipt threshold amount. This is only effective if the supplier enable goodsReceiptRequired flag. See goodsReceiptRequired field for more detail. Default: 0 |
poAckSupported boolean |
This flag indicates whether supplier can send acknowledgment for Purchase Order. true means that supplier can send acknowledgment for Purchase Order. false means that supplier cannot send acknowledgment for Purchase Order. Default: false |
allowCxmlOrderConfirmation boolean |
Is used to enable the supplier to send Order Confirmation via cXML. true means that supplier can send Order Confirmation via cXML. false means that supplier cannot send Order Confirmation via cXML. |
allowCxmlAdvanceShippingNotice boolean |
Is used to enable the supplier to send Ship Notice via cXML. true means that supplier can send Ship Notice via cXML. false means that supplier cannot send Ship Notice via cXML. |
leadTimeFrequency string |
Frequency of the Lead Time. Possible values: NO_DELIVERY_DATE, NO_OF_DAYS, NO_OF_WEEKS, NO_OF_MONTHS. If NO_DELIVERY_DATE is set, delivery date will not be sent in the purchase order cXML, if any other value is specified, the lead time value will be calculated based on the frequency specified |
leadTimeValue integer |
This field is used to calculate the expected delivery date based on the lead time frequency. |
active boolean |
Indicates whether or not this supplier is active in the system. true means active and false means inactive. |
poAttachmentsAllowed boolean |
Indicates whether or not this supplier is allowed for PO attachments true means attachments are supported and false means attachments are not supported. |
enableTaxAmount boolean |
Indicates whether or not this supplier supports tax amount true means tax amount is supported in cxml and false means not supported. |
partIdLineIdentifier boolean |
Part Id identified configuration which enable supplier to have this data supported in supplier cxml. |
advancedShipmentNoticeEnabled boolean |
Advanced Notice Shipment toggle which enable supplier to have ASN feature enabled. |
administrativeNotes string |
Administrative notes for this supplier. |
includeSupplierCard boolean |
Includes supplier card toggle which enable supplier card. |
singleSourceSupplier boolean |
Indicates whether this supplier is single source or not. |
automaticPRApproval boolean |
Indicates whether this supplier supports auto PR approvals. This field can be used with Single source supplier when set to true. |
autoApprovalThreshold number |
Auto approval threshold set for this supplier. This field can be used with Single source supplier when set to true |
minimumOrderValue number |
Minimum order quantity that this supplier supports. |
ersEnabled boolean |
Indicates whether this supplier supports ERS. |
sdmSupplier boolean |
Indicates whether this supplier is an SDM supplier. |
poChangeRequest boolean |
Indicates whether this supplier supports POCR. |
disableBrowse boolean |
Indicates whether this supplier is browsable in SDM. |
contacts [object] |
No description |
Contact Details object |
Contact Details of supplier |
id string |
id is optional field, if provided in the payload it will be saved, otherwise system generated id will be saved. This field should be unique in the given supplier. |
name string |
Name given to a contact. |
email string |
Email used by this contact. |
phone string |
Phone number of this contact. |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
logo string |
Stores Id of supplier logo uploaded on S3. |
language string |
The language of the supplier as two uppercase characters Default: EN |
poNotificationEmails [string] |
Set of unique email addresses for receiving PO notifications |
Enumerated Values
| Property | Value |
|---|---|
type |
PaymentTermModel |
type |
CompanyCodeModel |
language |
EN |
language |
EN_GB |
language |
EN_NZ |
language |
IT |
language |
JA |
language |
NO |
language |
SV |
SupplierReferenceDataModel
{
"id": "561234cdeacb256789aa",
"externalId": "1110",
"docNo": "123456",
"type": "SupplierModel",
"label": "Description for label",
"archived": false,
"name": "Vroozi",
"vendorId": "DefaultVendor10",
"address": {
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "BC01",
"roomNo": "201",
"floor": "201",
"email": "email@vroozi.com",
"phone": "+14151231234"
}
}
Properties
| Name | Description |
|---|---|
id string |
Primary key (ID) of the reference supplier. This id can be used to fetch supplier object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
docNo string |
Primary business identifier for this reference object i.e. uniqueId. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier |
archived boolean |
This flag indicates whether the referenced supplier has been archived. If true, this object cannot be retrieve or used for future reference. |
name string |
The name of the company associated with this supplier. |
vendorId string |
Business ID of this supplier in the Vendor Master Data |
address object |
A representation of supplier address |
street1 stringrequired |
Street 1 |
street2 string |
Street 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email stringrequired |
|
phone stringrequired |
Phone number in the international format i.e [+][country code][area code][local phone number] |
Enumerated Values
| Property | Value |
|---|---|
type |
SupplierModel |
TaxCodeListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
No description |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Name of this tax code for business use. |
description stringrequired |
Description for this tax code. |
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxable boolean |
Should this Tax Code be calculated? |
percent number |
Tax Percentage |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
TaxCodeModel
{
"id": "5c4567ceda4567cadea1ab789a",
"externalId": "20010",
"name": "DTC01",
"description": "Default Tax Code 01",
"companyCodeRefs": [
{
"type": "CompanyCodeModel"
}
],
"taxable": false,
"percent": 0,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
name stringrequired |
Name of this tax code for business use. |
description stringrequired |
Description for this tax code. |
companyCodeRefs any |
No description |
allOf
| Name | Description |
|---|---|
anonymous [object] |
No description |
id string |
Primary key (ID) of the reference data model. This id can be used to fetch this reference object. |
externalId string |
Primary key (ID) of the reference data model in external system. This externalId can be used to fetch this reference object by passing useExternalId flag in the header. |
docNo string |
Primary business identifier for this reference object. It can be code, name or document number depending on the type of reference object. |
type string |
Type of the Reference object |
label string |
This is the combination of business identifier and description for that identifier It is readonly field |
archived boolean |
This flag indicates whether the reference object has been archived. If true, this object cannot be retrieve or used for future reference. It is readonly field |
and
| Name | Description |
|---|---|
anonymous array |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
taxable boolean |
Should this Tax Code be calculated? |
percent number |
Tax Percentage |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
UserListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
List of users. |
User object |
A representation of the user |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
username stringrequired |
User name of the user. |
firstname stringrequired |
First Name of the user. |
lastname stringrequired |
Last name of user. |
email stringrequired |
The email of the user. |
phone string |
The phone number of the user. |
effectiveStartDate string(date) |
Effective start date of the object. Date will be output in format: yyyy-MM-dd |
effectiveEndDate string(date) |
Effective end date of the object. Date will be output in format: yyyy-MM-dd |
roles [string]required |
User Roles |
approvalLimit integer |
This is approval limit for APPROVER users in the system. Should be provided during Creation/Update. |
spendLimit integer |
This is spend limit for EMPLOYEE for PR auto approvals in the system. Should be provided during Creation/Update. |
contentGroup string |
Content group mapping this user has access to. |
userDefaults object |
A representation of the user defaults |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
costCenterRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
wbsElementRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
internalOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of user address |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
addressType [string] |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
Phone |
active boolean |
Indicates if the address is active or not |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCentertRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
currency string |
Currency Code used by supplier. CurrencyCode should be three character code. Ex: USD for US Dollars. |
active boolean |
To indicate whether or not this user is active in the system. true means active and false means inactive. Default: false |
defaultApproverRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
nextApproverRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
language string |
The language of the supplier as two uppercase characters |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dashboardTypes [string] |
The dashboard visible to this user Note: For the ADMINISTRATOR role, all available dashboard types will be auto-assigned even if they are not specified in the payload. |
Enumerated Values
| Property | Value |
|---|---|
roles |
EMPLOYEE |
roles |
PAYMENT_REQUESTOR |
roles |
SUBMIT_QUOTE_REQUEST_FORM |
roles |
SUBMIT_QUOTE_REQUEST |
roles |
RESTRICT_FROM_CODING_OF_PR_AND_PO |
roles |
CENTRAL_RECEIVER |
roles |
SOURCING_APPROVER |
roles |
APPROVER |
roles |
APPROVER_PAYMENT_REQUESTS |
roles |
BUYER |
roles |
MANAGE_SUPPLIERS |
roles |
AP_PROCESSOR |
roles |
AP_MANAGER |
roles |
AP_APPROVER |
roles |
AP_CODER |
roles |
AP_EDITOR |
roles |
AP_AUDITOR |
roles |
ADMINISTRATOR |
roles |
EXPENSE |
roles |
SUPPLIER_DISCOVERY_ADMIN |
roles |
SUPPLIER_DISCOVERY_POWER_USER |
roles |
SUPPLIER_DISCOVERY_BASIC_USER |
roles |
SUPPLIER_DISCOVERY_EF_APPROVER |
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
PlantCodeModel |
type |
WBSElementModel |
type |
InternalOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
ClassModel |
type |
ProjectModel |
type |
LocationTypeModel |
type |
LocationModel |
type |
ProfitCenterModel |
type |
UserModel |
type |
UserModel |
language |
EN |
language |
EN_GB |
language |
EN_NZ |
language |
IT |
language |
JA |
language |
NO |
language |
SV |
dashboardTypes |
ADMIN_DASHBOARD |
dashboardTypes |
AP_MANAGER_DASHBOARD |
dashboardTypes |
PM_DASHBOARD |
UserModel
{
"id": "1136",
"externalId": "1110",
"username": "test@test.voorzi.com",
"firstname": "Sambhu",
"lastname": "Sai",
"email": "test@test.vroozi.com",
"phone": "15233549511",
"effectiveStartDate": "2018-05-04",
"effectiveEndDate": "2018-05-04",
"roles": [
"EMPLOYEE",
"CENTRAL_RECEIVER"
],
"approvalLimit": 10000,
"spendLimit": 500,
"contentGroup": "Profile_Group_589322604",
"userDefaults": {
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"costCenterRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CostCenterModel",
"label": "Description for label",
"archived": false
},
"plantCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PlantCodeModel",
"label": "Description for label",
"archived": false
},
"wbsElementRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "WBSElementModel",
"label": "Description for label",
"archived": false
},
"internalOrderRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "InternalOrderModel",
"label": "Description for label",
"archived": false
},
"shippingAddress": {
"id": "5abbd758e61c824a33ded63a",
"externalId": "10",
"addressId": "1000000100",
"addressType": [
"shipping",
"billing",
"company"
],
"street1": "15000 Ventura Blvd",
"street2": "Suite# 201",
"city": "Sherman Oaks",
"postalCode": "91403",
"state": {
"name": "California",
"code": "CA"
},
"country": {
"name": "United States of America",
"code": "US"
},
"buildingCode": "VZI Building",
"roomNo": "201",
"floor": "2nd",
"email": "email@vroozi.com",
"phone": "17187372722",
"active": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
},
"classRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ClassModel",
"label": "Description for label",
"archived": false
},
"projectRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProjectModel",
"label": "Description for label",
"archived": false
},
"locationTypeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationTypeModel",
"label": "Description for label",
"archived": false
},
"locationRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "LocationModel",
"label": "Description for label",
"archived": false
},
"profitCentertRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "ProfitCenterModel",
"label": "Description for label",
"archived": false
},
"currency": "USD"
},
"active": true,
"defaultApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"nextApproverRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "UserModel",
"label": "Description for label",
"archived": false
},
"language": "JA",
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000",
"dashboardTypes": [
"ADMIN_DASHBOARD"
]
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
username stringrequired |
User name of the user. |
firstname stringrequired |
First Name of the user. |
lastname stringrequired |
Last name of user. |
email stringrequired |
The email of the user. |
phone string |
The phone number of the user. |
effectiveStartDate string(date) |
Effective start date of the object. Date will be output in format: yyyy-MM-dd |
effectiveEndDate string(date) |
Effective end date of the object. Date will be output in format: yyyy-MM-dd |
roles [string]required |
User Roles |
approvalLimit integer |
This is approval limit for APPROVER users in the system. Should be provided during Creation/Update. |
spendLimit integer |
This is spend limit for EMPLOYEE for PR auto approvals in the system. Should be provided during Creation/Update. |
contentGroup string |
Content group mapping this user has access to. |
userDefaults object |
A representation of the user defaults |
companyCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
costCenterRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type any |
No description |
continued
| Name | Description |
|---|---|
plantCodeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
wbsElementRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
internalOrderRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
shippingAddress object |
A representation of user address |
id string |
System generated unique identifier for this object. |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
addressId string |
Unique Address ID associated with this address. New addressId will be generated if not provided. |
addressType [string] |
Type of address Possible values: shipping, billing and/or company |
street1 stringrequired |
Street Line 1 |
street2 string |
Street Line 2 |
city stringrequired |
City |
postalCode stringrequired |
Postal Code |
state objectrequired |
State - Request should contain at least one of code or name. If the country is US than the valid code or name of US states should be used. For other countries these fields can contain any free text value. |
name string |
Name is the name of the state. |
code string |
Code is the two character state code. |
country objectrequired |
Country - Request should contain at least one of code or name. |
name string |
Name is the name of the country. |
code string |
Code is the two character country code. |
buildingCode string |
Building Code |
roomNo string |
Room No |
floor string |
Floor |
email string |
|
phone string |
Phone |
active boolean |
Indicates if the address is active or not |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
classRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
projectRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationTypeRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
locationRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
profitCentertRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
currency string |
Currency Code used by supplier. CurrencyCode should be three character code. Ex: USD for US Dollars. |
active boolean |
To indicate whether or not this user is active in the system. true means active and false means inactive. Default: false |
defaultApproverRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
nextApproverRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
language string |
The language of the supplier as two uppercase characters |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
dashboardTypes [string] |
The dashboard visible to this user Note: For the ADMINISTRATOR role, all available dashboard types will be auto-assigned even if they are not specified in the payload. |
Enumerated Values
| Property | Value |
|---|---|
roles |
EMPLOYEE |
roles |
PAYMENT_REQUESTOR |
roles |
SUBMIT_QUOTE_REQUEST_FORM |
roles |
SUBMIT_QUOTE_REQUEST |
roles |
RESTRICT_FROM_CODING_OF_PR_AND_PO |
roles |
CENTRAL_RECEIVER |
roles |
SOURCING_APPROVER |
roles |
APPROVER |
roles |
APPROVER_PAYMENT_REQUESTS |
roles |
BUYER |
roles |
MANAGE_SUPPLIERS |
roles |
AP_PROCESSOR |
roles |
AP_MANAGER |
roles |
AP_APPROVER |
roles |
AP_CODER |
roles |
AP_EDITOR |
roles |
AP_AUDITOR |
roles |
ADMINISTRATOR |
roles |
EXPENSE |
roles |
SUPPLIER_DISCOVERY_ADMIN |
roles |
SUPPLIER_DISCOVERY_POWER_USER |
roles |
SUPPLIER_DISCOVERY_BASIC_USER |
roles |
SUPPLIER_DISCOVERY_EF_APPROVER |
type |
CompanyCodeModel |
type |
CostCenterModel |
type |
WBSElementModel |
type |
InternalOrderModel |
type |
ProfitCenterModel |
type |
PlantCodeModel |
type |
WBSElementModel |
type |
InternalOrderModel |
addressType |
shipping |
addressType |
billing |
addressType |
company |
type |
ClassModel |
type |
ProjectModel |
type |
LocationTypeModel |
type |
LocationModel |
type |
ProfitCenterModel |
type |
UserModel |
type |
UserModel |
language |
EN |
language |
EN_GB |
language |
EN_NZ |
language |
IT |
language |
JA |
language |
NO |
language |
SV |
dashboardTypes |
ADMIN_DASHBOARD |
dashboardTypes |
AP_MANAGER_DASHBOARD |
dashboardTypes |
PM_DASHBOARD |
VoidPaymentModel
{
"paymentRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "PaymentModel",
"label": "Description for label",
"archived": false
},
"voidedDate": "2017-06-28T22:05:47.368+0000",
"referenceNo": "123334322",
"notes": "There was an error in the gateway"
}
Properties
| Name | Description |
|---|---|
paymentRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
voidedDate string(date-time)required |
Date when the payment is voided. Dates are accepted in UTC format. Supported Formats are [yyyy-MM-dd’T’HH:mm:ss.SSSZ, yyyy-MM-dd’T’HH:mm:ss.SSS, yyyy-MM-dd’T’HH:mm:ss, yyyy-MM-dd] |
referenceNo string |
External system generated void reference number for this payment. |
notes string |
Descriptive notes that why payment is to be voided |
Enumerated Values
| Property | Value |
|---|---|
type |
PaymentModel |
VrooziApiAsyncRequestModel
{
"id": "5a3bd758e61c824a33ded63a",
"trackingId": "123-2123",
"requestPath": "status-update",
"requestMethod": "status-update",
"docType": "InvoiceModel",
"processingResult": {
"metadata": {
"payloadRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "AttachmentModel",
"label": "Description for label",
"archived": false
},
"invoiceNumber": "9000001616",
"externalId": "20010001",
"vendorInvoiceNumber": "123456789"
},
"status": "SUCCESS",
"errors": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
],
"warnings": [
{
"code": "400",
"element": "name",
"message": "Field [name] cannot be null or empty.",
"detail": "Field [name] cannot be null or empty.",
"level": "Field Error"
}
]
},
"status": "IN_PROGRESS",
"dateCreated": "2023-03-15T13:56:04.037+0000",
"lastUpdated": "2023-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object (Read only). |
trackingId string |
System generated id to uniquely identify invoice status update request |
requestPath string |
Path of the actual async API related to this tracking request. |
requestMethod string |
Request method used for the actual API, e.g GET, PUT, POST, DELETE etc. |
docType string |
The transactional document type. |
processingResult object |
A representation of tracking progress of async requests. |
metadata object |
A representation of tracking progress of async requests. |
payloadRef any |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
invoiceNumber string |
System generated unique number (Read only). |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
vendorInvoiceNumber string |
Vendor Invoice Number |
status string |
Async Operation Status of Invoice Reference |
errors [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
warnings [object] |
No description |
A representation of error or warnings. object |
A representation of error or warnings. |
code string |
System generated unique identifier for this error. |
element string |
Error related to element/field |
message string |
Error message |
detail string |
Details related to error |
level string |
Level of error severity |
status string |
Processing status of Async Request |
dateCreated string(date-time) |
Creation date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
lastUpdated string(date-time) |
Last updated date of the object (Read only). Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Enumerated Values
| Property | Value |
|---|---|
docType |
InvoiceModel |
type |
AttachmentModel |
status |
SUCCESS |
status |
UNCHANGED |
status |
FAILED |
status |
IN_PROGRESS |
status |
ERROR |
status |
COMPLETED |
status |
COMPLETED_WITH_FAILURE |
status |
COMPLETED_WITH_WARNING |
VrooziApiAsyncResponseModel
{
"trackingId": "123-2123",
"status": "Processing",
"timestamp": "2023-03-15T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
trackingId string |
System generated id to uniquely identify invoice status update request |
status string |
Status of the invoice status update request |
timestamp string(date-time) |
Time of the invoice status update request recieved Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
WBSElementListModel
{
"pageDetails": {
"currentPage": 1,
"pageCount": 25,
"totalPages": 13,
"totalCount": 325
},
"content": [
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
]
}
Properties
| Name | Description |
|---|---|
pageDetails object |
Pagination details for a response. |
currentPage integer |
Current page number returned out of the total pages, starting at 1. |
pageCount integer |
Total number of records found in current page. |
totalPages integer |
Total number of pages found against the request. |
totalCount integer |
Total number of records in the result. |
content [object] |
Array of wbs elements. |
WBS Element object |
A representation of the WBS Element |
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this WBS Element for business use. |
description stringrequired |
Description for this WBS Element. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
active boolean |
To indicate whether or not this WBS Element is active in the system. true means active and false means inactive. Default: false |
profitCenter string |
Profit Center |
project string |
Project Name |
projectDescription string |
Project Description |
specialFlag boolean |
Special Flag |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |
WBSElementModel
{
"id": "5a3bd758e61c824a33ded63a",
"externalId": "1001",
"code": "GL000101",
"description": "WBS Element 1101001",
"companyCodeRef": {
"id": "561234cdeacb256789aa",
"externalId": "11001",
"docNo": "CC01",
"type": "CompanyCodeModel",
"label": "Description for label",
"archived": false
},
"budgetInfo": {
"amount": 20.3,
"timeFrequency": "MONTHLY"
},
"active": true,
"profitCenter": "Profit Center - 123",
"project": "PROJECT-123",
"projectDescription": "Project Description - 111110101",
"specialFlag": true,
"dateCreated": "2018-03-15T13:56:04.037+0000",
"lastUpdated": "2018-04-05T13:56:04.037+0000"
}
Properties
| Name | Description |
|---|---|
id string |
System generated unique identifier for this object. It is readonly field |
externalId string |
Unique identifier for this object in external system. Should be provided during Creation/Update. |
code stringrequired |
Code of this WBS Element for business use. |
description stringrequired |
Description for this WBS Element. |
companyCodeRef anyrequired |
No description |
allOf
| Name | Description |
|---|---|
anonymous |
No description |
and
| Name | Description |
|---|---|
anonymous object |
No description |
type string |
No description |
continued
| Name | Description |
|---|---|
budgetInfo object |
A representation of the budget info |
amount number |
Budget Amount |
timeFrequency string |
Budget Time Frequency |
active boolean |
To indicate whether or not this WBS Element is active in the system. true means active and false means inactive. Default: false |
profitCenter string |
Profit Center |
project string |
Project Name |
projectDescription string |
Project Description |
specialFlag boolean |
Special Flag |
dateCreated string(date-time) |
Creation date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
lastUpdated string(date-time) |
Last updated date of the object. Date will be output in format: yyyy-MM-dd’T’HH:mm:ss.SSSZ It is readonly field |
Enumerated Values
| Property | Value |
|---|---|
type |
CompanyCodeModel |
timeFrequency |
WEEKLY |
timeFrequency |
MONTHLY |
timeFrequency |
QUARTERLY |
timeFrequency |
YEARLY |