Endpoints:
- POST /v1/Organizations/:id/priceLists
- GET /v1/PriceLists/:id
- GET /v1/Organizations/:id/priceLists
- GET /v1/Organizations/:id/priceLists/count
- PATCH /v1/PriceLists/:id
- DELETE /v1/PriceLists/:id
- POST /v1/PriceLists/:id/prices
- GET /v1/PriceLists/:id/prices
- GET /v1/PriceLists/:id/prices/count
- PATCH /v1/Prices/:id
- DELETE /v1/Prices/:id
The PriceList object
Parameters
-
id string readonly
-
name string
-
active boolean
-
activeFrom date
-
activeTo date
-
Is price list for sale or purchase items
-
organizationId string readonly
-
clientId string
-
deletedAt date readonly
-
_isDeleted boolean readonly
-
deletedId string readonly
-
createdAt date readonly
-
updatedAt date readonly
-
Custom field for freeform data input
Additional propertiesExpand all
{
"name": "string",
"active": true,
"activeFrom": "2022-04-20T10:10:30+00:00Z",
"activeTo": "2022-04-20T10:10:30+00:00Z",
"type": "sale",
"id": "string",
"organizationId": "string",
"clientId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
Create PriceList
POST /v1/Organizations/:id/priceLists
Parameters
Path
-
id string required
Organization id
Properties
-
name string required
-
Default is: true
-
activeFrom date optional
-
activeTo date optional
-
Default is: sale
Is price list for sale or purchase items
-
clientId string optional
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
name: 'string',
active: true,
activeFrom: '2022-04-20T10:10:30+00:00Z',
activeTo: '2022-04-20T10:10:30+00:00Z',
type: 'sale',
clientId: 'string',
custom: {}
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "string", \
"active": true, \
"activeFrom": "2022-04-20T10:10:30+00:00Z", \
"activeTo": "2022-04-20T10:10:30+00:00Z", \
"type": "sale", \
"clientId": "string", \
"custom": {}
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'name': 'string',
'active': True,
'activeFrom': '2022-04-20T10:10:30+00:00Z',
'activeTo': '2022-04-20T10:10:30+00:00Z',
'type': 'sale',
'clientId': 'string',
'custom': {}
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"name": "string",
"active": true,
"activeFrom": "2022-04-20T10:10:30+00:00Z",
"activeTo": "2022-04-20T10:10:30+00:00Z",
"type": "sale",
"id": "string",
"organizationId": "string",
"clientId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
Get PriceList
GET /v1/PriceLists/:id
Parameters
Path
-
id string required
Model id
Query
-
filter string optional
Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/PriceLists/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"name": "string",
"active": true,
"activeFrom": "2022-04-20T10:10:30+00:00Z",
"activeTo": "2022-04-20T10:10:30+00:00Z",
"type": "sale",
"id": "string",
"organizationId": "string",
"clientId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
Find PriceLists
GET /v1/Organizations/:id/priceLists
Parameters
Path
-
id string required
Organization id
Query
-
filter string optional
const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
[
{
"name": "string",
"active": true,
"activeFrom": "2022-04-20T10:10:30+00:00Z",
"activeTo": "2022-04-20T10:10:30+00:00Z",
"type": "sale",
"id": "string",
"organizationId": "string",
"clientId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
]
Count PriceLists
GET /v1/Organizations/:id/priceLists/count
Parameters
Path
-
id string required
Organization id
Query
-
where string optional
Criteria to match model instances
const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists/count', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists/count \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/priceLists/count'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 42
}
Patch PriceList
PATCH /v1/PriceLists/:id
Parameters
Path
-
id string required
PriceList id
Properties
-
name string required
-
Default is: true
-
activeFrom date optional
-
activeTo date optional
-
Default is: sale
Is price list for sale or purchase items
-
clientId string optional
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}', {
method: 'PATCH',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
name: 'string',
active: true,
activeFrom: '2022-04-20T10:10:30+00:00Z',
activeTo: '2022-04-20T10:10:30+00:00Z',
type: 'sale',
clientId: 'string',
custom: {}
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X PATCH https://api.spaceinvoices.com/v1/PriceLists/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "string", \
"active": true, \
"activeFrom": "2022-04-20T10:10:30+00:00Z", \
"activeTo": "2022-04-20T10:10:30+00:00Z", \
"type": "sale", \
"clientId": "string", \
"custom": {}
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'name': 'string',
'active': True,
'activeFrom': '2022-04-20T10:10:30+00:00Z',
'activeTo': '2022-04-20T10:10:30+00:00Z',
'type': 'sale',
'clientId': 'string',
'custom': {}
}
response = requests.patch(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"name": "string",
"active": true,
"activeFrom": "2022-04-20T10:10:30+00:00Z",
"activeTo": "2022-04-20T10:10:30+00:00Z",
"type": "sale",
"id": "string",
"organizationId": "string",
"clientId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}', {
method: 'DELETE',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X DELETE https://api.spaceinvoices.com/v1/PriceLists/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 1
}
Create Price for PriceList
POST /v1/PriceLists/:id/prices
Parameters
Path
-
id string required
PriceList id
Properties
-
amount number required
-
priceListId string optional
-
itemId string optional
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}/prices', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
amount: 42,
priceListId: 'string',
itemId: 'string',
custom: {}
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/PriceLists/{id}/prices \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"amount": 42, \
"priceListId": "string", \
"itemId": "string", \
"custom": {}
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}/prices'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'amount': 42,
'priceListId': 'string',
'itemId': 'string',
'custom': {}
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"amount": 42,
"id": "string",
"priceListId": "string",
"itemId": "string",
"organizationId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
Get PriceList Prices
GET /v1/PriceLists/:id/prices
Parameters
Path
-
id string required
PriceList id
Query
-
filter string optional
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}/prices', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/PriceLists/{id}/prices \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}/prices'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
[
{
"amount": 42,
"id": "string",
"priceListId": "string",
"itemId": "string",
"organizationId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
]
Get count of Prices
GET /v1/PriceLists/:id/prices/count
Parameters
Path
-
id string required
PriceList id
Query
-
where string optional
Criteria to match model instances
const response = await fetch('https://api.spaceinvoices.com/v1/PriceLists/{id}/prices/count', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/PriceLists/{id}/prices/count \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/PriceLists/{id}/prices/count'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 42
}
Update Price
PATCH /v1/Prices/:id
Parameters
Path
-
id string required
Price id
Properties
-
amount number required
-
priceListId string optional
-
itemId string optional
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/Prices/{id}', {
method: 'PATCH',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
amount: 42,
priceListId: 'string',
itemId: 'string',
custom: {}
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X PATCH https://api.spaceinvoices.com/v1/Prices/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"amount": 42, \
"priceListId": "string", \
"itemId": "string", \
"custom": {}
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Prices/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'amount': 42,
'priceListId': 'string',
'itemId': 'string',
'custom': {}
}
response = requests.patch(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"amount": 42,
"id": "string",
"priceListId": "string",
"itemId": "string",
"organizationId": "string",
"deletedAt": "2022-04-20T10:10:30+00:00Z",
"_isDeleted": false,
"deletedId": "string",
"createdAt": "2022-04-20T10:10:30+00:00Z",
"updatedAt": "2022-04-20T10:10:30+00:00Z",
"custom": {}
}
const response = await fetch('https://api.spaceinvoices.com/v1/Prices/{id}', {
method: 'DELETE',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X DELETE https://api.spaceinvoices.com/v1/Prices/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Prices/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 1
}