Create Agreement
Body
idstringOptional
auditall ofOptional
$metaall of | nullableOptional
iconstring | nullableOptional
statusall ofOptional
string · enumOptionalPossible values:
listingall ofOptional
authorizationall ofOptional
vendorall ofOptional
clientall ofOptional
priceall ofOptional
startDatestring · date-time | nullableOptional
endDatestring · date-time | nullableOptional
templateall ofOptional
errorall of | nullableOptional
namestringOptional
parametersall ofOptional
licenseeall ofOptional
buyerall ofOptional
sellerall ofOptional
productall ofOptional
externalIdsall ofOptional
splitall of | nullableOptional
Responses
201
Created
application/json
400
Bad Request
application/json
403
Forbidden
application/json
500
Internal Server Error
post
POST /public/v1/commerce/agreements HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 6078
{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"active": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"provisioning": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"terminated": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"status": "New",
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"startDate": "2025-08-09T11:51:18.635Z",
"endDate": "2025-08-09T11:51:18.635Z",
"template": {
"id": "text",
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
{
"id": "text",
"quantity": 1,
"item": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
},
"group": {
"id": "text",
"name": "text"
},
"unit": {
"id": "text",
"description": "text",
"name": "text"
},
"terms": {
"period": "1m",
"commitment": "1m"
},
"quantityNotApplicable": true,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"externalId": "text",
"type": "text",
"name": "text",
"value": null,
"displayValue": "text"
}
]
},
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"terminated": "[Circular Reference]",
"deleted": "[Circular Reference]"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"unitSP": 1,
"unitPP": 1,
"PPx1": 1,
"SPx1": 1
},
"order": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"type": "Purchase",
"status": "New",
"notes": "text",
"comments": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text"
},
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"assignee": {
"id": "text",
"name": "text",
"icon": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkup": 1,
"PPx1": 1,
"SPx1": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"lines": [
"[Circular Reference]"
],
"subscriptions": [
"[Circular Reference]"
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"billTo": {
"id": "text",
"icon": "text",
"name": "text"
},
"pricingPolicy": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"termsAndConditions": [
"[Circular Reference]"
],
"certificates": [
{
"id": "text",
"name": "text"
}
],
"defaultMarkupSource": "Unknown"
},
"status": "Active"
}
],
"subscriptions": [
{
"id": "text",
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"allocations": [
{
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"percentage": 1,
"price": {
"currency": "text",
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"audit": "[Circular Reference]",
"statistics": {
"subscriptions": 1
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
}
}
]
},
"termsAndConditions": [
{
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"accepted": "2025-08-09T11:51:18.635Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
],
"certificates": [
{
"id": "text",
"name": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"active": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"provisioning": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
},
"terminated": {
"at": "2025-08-09T11:51:18.635Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"status": "New",
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"startDate": "2025-08-09T11:51:18.635Z",
"endDate": "2025-08-09T11:51:18.635Z",
"template": {
"id": "text",
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
{
"id": "text",
"quantity": 1,
"item": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
},
"group": {
"id": "text",
"name": "text"
},
"unit": {
"id": "text",
"description": "text",
"name": "text"
},
"terms": {
"period": "1m",
"commitment": "1m"
},
"quantityNotApplicable": true,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"externalId": "text",
"type": "text",
"name": "text",
"value": null,
"displayValue": "text"
}
]
},
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"terminated": "[Circular Reference]",
"deleted": "[Circular Reference]"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"unitSP": 1,
"unitPP": 1,
"PPx1": 1,
"SPx1": 1
},
"order": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"type": "Purchase",
"status": "New",
"notes": "text",
"comments": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text"
},
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"assignee": {
"id": "text",
"name": "text",
"icon": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkup": 1,
"PPx1": 1,
"SPx1": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"lines": [
"[Circular Reference]"
],
"subscriptions": [
"[Circular Reference]"
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"billTo": {
"id": "text",
"icon": "text",
"name": "text"
},
"pricingPolicy": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"termsAndConditions": [
"[Circular Reference]"
],
"certificates": [
{
"id": "text",
"name": "text"
}
],
"defaultMarkupSource": "Unknown"
},
"status": "Active"
}
],
"subscriptions": [
{
"id": "text",
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Configuration",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"allocations": [
{
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"percentage": 1,
"price": {
"currency": "text",
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"audit": "[Circular Reference]",
"statistics": {
"subscriptions": 1
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
}
}
]
},
"termsAndConditions": [
{
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"accepted": "2025-08-09T11:51:18.635Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
],
"certificates": [
{
"id": "text",
"name": "text"
}
]
}Last updated
Was this helpful?