Update Agreement

Updates an existing agreement

put

Path parameters

idstringrequired

Id of existing agreement to update

Body

application/jsontext/jsonapplication/*+json

idstringoptional

auditobjectoptional

$metaobjectoptional

hrefstringread-onlyoptional

iconstring | nullableoptional

statusstring · enumoptional

Available options:

listingobjectoptional

authorizationobjectoptional

vendorobjectoptional

clientobjectoptional

priceobjectoptional

startDatestring · date-time | nullableoptional

endDatestring · date-time | nullableoptional

templateobjectoptional

errorobjectoptional

namestringoptional

linesobject[] | nullableoptional

subscriptionsobject[] | nullableoptional

parametersobjectoptional

licenseeobjectoptional

buyerobjectoptional

sellerobjectoptional

productobjectoptional

externalIdsobjectoptional

splitobjectoptional

termsAndConditionsobject[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/agreements/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-04-01T21:45:51.678Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-04-01T21:45:51.678Z",
        "by": "[Circular Reference]"
      },
      "active": {
        "at": "2025-04-01T21:45:51.678Z",
        "by": "[Circular Reference]"
      },
      "provisioning": {
        "at": "2025-04-01T21:45:51.678Z",
        "by": "[Circular Reference]"
      },
      "terminated": {
        "at": "2025-04-01T21:45:51.678Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "status": "New",
    "listing": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "authorization": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "currency": "text",
        "notes": "text",
        "product": "[Circular Reference]",
        "vendor": "[Circular Reference]",
        "owner": "[Circular Reference]",
        "statistics": {
          "subscriptions": 1,
          "agreements": 1,
          "sellers": 1,
          "listings": 1
        }
      },
      "product": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "shortDescription": "text",
        "longDescription": "text",
        "externalIds": {
          "operations": "text"
        },
        "website": "text",
        "status": "text",
        "vendor": "[Circular Reference]",
        "settings": {
          "productOrdering": true,
          "productRequests": {
            "enabled": true,
            "name": "text",
            "label": "text"
          },
          "itemSelection": true,
          "orderQueueChanges": true,
          "preValidation": {
            "purchaseOrderDraft": true,
            "purchaseOrderQuerying": true,
            "changeOrderDraft": true,
            "terminationOrder": true,
            "productRequest": true
          },
          "splitBilling": {
            "enabled": true,
            "type": "text"
          }
        },
        "statistics": {
          "itemCount": 1,
          "ordersPlacedCount": 1,
          "agreementCount": 1,
          "subscriptionCount": 1,
          "requestCount": 1
        }
      },
      "vendor": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "seller": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalId": "text",
        "status": "Active",
        "icon": "text",
        "currencies": [
          "text"
        ],
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "name": "text"
      },
      "priceList": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "currency": "text",
        "precision": 1,
        "defaultMarkup": 1,
        "notes": "text",
        "externalIds": {
          "vendor": "text"
        },
        "statistics": {
          "sellers": 1,
          "listings": 1,
          "priceListItems": 1,
          "purchasePriceItems": 1,
          "purchasePriceCompleteness": 1,
          "salesPriceItems": 1,
          "salesPriceCompleteness": 1,
          "averageMarkup": 1,
          "averageMargin": 1
        },
        "product": "[Circular Reference]",
        "vendor": "[Circular Reference]"
      },
      "primary": true,
      "notes": "text",
      "statistics": {
        "subscriptions": 1,
        "agreements": 1
      }
    },
    "authorization": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "externalIds": {
        "operations": "text"
      },
      "currency": "text",
      "notes": "text",
      "product": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "shortDescription": "text",
        "longDescription": "text",
        "externalIds": {
          "operations": "text"
        },
        "website": "text",
        "status": "text",
        "vendor": "[Circular Reference]",
        "settings": {
          "productOrdering": true,
          "productRequests": {
            "enabled": true,
            "name": "text",
            "label": "text"
          },
          "itemSelection": true,
          "orderQueueChanges": true,
          "preValidation": {
            "purchaseOrderDraft": true,
            "purchaseOrderQuerying": true,
            "changeOrderDraft": true,
            "terminationOrder": true,
            "productRequest": true
          },
          "splitBilling": {
            "enabled": true,
            "type": "text"
          }
        },
        "statistics": {
          "itemCount": 1,
          "ordersPlacedCount": 1,
          "agreementCount": 1,
          "subscriptionCount": 1,
          "requestCount": 1
        }
      },
      "vendor": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "owner": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalId": "text",
        "status": "Active",
        "icon": "text",
        "currencies": [
          "text"
        ],
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "name": "text"
      },
      "statistics": {
        "subscriptions": 1,
        "agreements": 1,
        "sellers": 1,
        "listings": 1
      }
    },
    "vendor": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        "[Circular Reference]"
      ]
    },
    "client": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        "[Circular Reference]"
      ]
    },
    "price": {
      "currency": "text",
      "markup": 1,
      "margin": 1,
      "SPxY": 1,
      "SPxM": 1,
      "PPxY": 1,
      "PPxM": 1
    },
    "startDate": "2025-04-01T21:45:51.678Z",
    "endDate": "2025-04-01T21:45:51.678Z",
    "template": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "content": "text",
      "type": "OrderProcessing",
      "default": true,
      "product": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "shortDescription": "text",
        "longDescription": "text",
        "externalIds": {
          "operations": "text"
        },
        "website": "text",
        "status": "text",
        "vendor": "[Circular Reference]",
        "settings": {
          "productOrdering": true,
          "productRequests": {
            "enabled": true,
            "name": "text",
            "label": "text"
          },
          "itemSelection": true,
          "orderQueueChanges": true,
          "preValidation": {
            "purchaseOrderDraft": true,
            "purchaseOrderQuerying": true,
            "changeOrderDraft": true,
            "terminationOrder": true,
            "productRequest": true
          },
          "splitBilling": {
            "enabled": true,
            "type": "text"
          }
        },
        "statistics": {
          "itemCount": 1,
          "ordersPlacedCount": 1,
          "agreementCount": 1,
          "subscriptionCount": 1,
          "requestCount": 1
        }
      }
    },
    "error": {
      "id": "text",
      "message": "text",
      "parameters": null
    },
    "name": "text",
    "lines": [
      {
        "id": "text",
        "quantity": 1,
        "item": "[Circular Reference]",
        "audit": "[Circular Reference]",
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "unitSP": 1,
          "unitPP": 1,
          "PPx1": 1,
          "SPx1": 1
        },
        "order": "[Circular Reference]",
        "status": "Active"
      }
    ],
    "subscriptions": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "startDate": "2025-04-01T21:45:51.678Z",
        "terminationDate": "2025-04-01T21:45:51.678Z",
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        },
        "agreement": "[Circular Reference]",
        "terms": {
          "period": "1m",
          "commitment": "1m"
        },
        "product": "[Circular Reference]",
        "autoRenew": true,
        "status": "Active",
        "commitmentDate": "2025-04-01T21:45:51.678Z",
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "SPxY": 1,
          "SPxM": 1,
          "PPxY": 1,
          "PPxM": 1,
          "defaultMarkup": 1,
          "defaultMargin": 1
        },
        "parameters": {
          "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
            }
          ]
        },
        "buyer": "[Circular Reference]",
        "licensee": "[Circular Reference]",
        "seller": "[Circular Reference]",
        "split": "[Circular Reference]",
        "splitStatus": "Disabled",
        "lines": "[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
        }
      ]
    },
    "licensee": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "contact": {
        "firstName": "text",
        "lastName": "text",
        "email": "[e-mail]",
        "phone": {
          "prefix": "text",
          "number": "text"
        },
        "user": "[Circular Reference]",
        "type": "text"
      },
      "name": "text",
      "externalId": "text",
      "status": "Active",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "useBuyerAddress": true,
      "description": "text",
      "account": {
        "id": "text",
        "audit": {
          "created": "[Circular Reference]",
          "updated": "[Circular Reference]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "buyer": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "contact": "[Circular Reference]",
        "externalIds": {
          "erpCompanyContact": "text",
          "erpCustomer": "text",
          "accountExternalId": "text"
        },
        "status": "Active",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "taxId": "text",
        "account": "[Circular Reference]",
        "name": "text",
        "errors": [
          {
            "id": "text",
            "message": "text",
            "parameters": null
          }
        ],
        "sellers": "[Circular Reference]"
      },
      "seller": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalId": "text",
        "status": "Active",
        "icon": "text",
        "currencies": [
          "text"
        ],
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "name": "text"
      }
    },
    "buyer": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "activated": "[Circular Reference]",
        "unassigned": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "contact": {
        "firstName": "text",
        "lastName": "text",
        "email": "[e-mail]",
        "phone": {
          "prefix": "text",
          "number": "text"
        },
        "user": "[Circular Reference]",
        "type": "text"
      },
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "status": "Active",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "taxId": "text",
      "account": {
        "id": "text",
        "audit": {
          "created": "[Circular Reference]",
          "updated": "[Circular Reference]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "name": "text",
      "errors": [
        {
          "id": "text",
          "message": "text",
          "parameters": null
        }
      ],
      "sellers": [
        "[Circular Reference]"
      ]
    },
    "seller": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text"
    },
    "product": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "published": "[Circular Reference]",
        "pending": "[Circular Reference]",
        "unpublished": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "status": "text",
      "vendor": {
        "id": "text",
        "audit": {
          "created": "[Circular Reference]",
          "updated": "[Circular Reference]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    },
    "externalIds": {
      "client": "text",
      "operations": "text",
      "vendor": "text"
    },
    "split": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "allocations": [
        "[Circular Reference]"
      ]
    },
    "termsAndConditions": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "description": "text",
        "displayOrder": 1,
        "status": "text",
        "product": "[Circular Reference]",
        "accepted": "2025-04-01T21:45:51.678Z",
        "acceptedBy": {
          "id": "text",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "text",
          "icon": "text"
        }
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

404

500

200

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-04-01T21:45:51.678Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-04-01T21:45:51.678Z",
      "by": "[Circular Reference]"
    },
    "active": {
      "at": "2025-04-01T21:45:51.678Z",
      "by": "[Circular Reference]"
    },
    "provisioning": {
      "at": "2025-04-01T21:45:51.678Z",
      "by": "[Circular Reference]"
    },
    "terminated": {
      "at": "2025-04-01T21:45:51.678Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "icon": "text",
  "status": "New",
  "listing": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "authorization": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "externalIds": {
        "operations": "text"
      },
      "currency": "text",
      "notes": "text",
      "product": "[Circular Reference]",
      "vendor": "[Circular Reference]",
      "owner": "[Circular Reference]",
      "statistics": {
        "subscriptions": 1,
        "agreements": 1,
        "sellers": 1,
        "listings": 1
      }
    },
    "product": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "status": "text",
      "vendor": "[Circular Reference]",
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    },
    "vendor": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "seller": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text"
    },
    "priceList": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "currency": "text",
      "precision": 1,
      "defaultMarkup": 1,
      "notes": "text",
      "externalIds": {
        "vendor": "text"
      },
      "statistics": {
        "sellers": 1,
        "listings": 1,
        "priceListItems": 1,
        "purchasePriceItems": 1,
        "purchasePriceCompleteness": 1,
        "salesPriceItems": 1,
        "salesPriceCompleteness": 1,
        "averageMarkup": 1,
        "averageMargin": 1
      },
      "product": "[Circular Reference]",
      "vendor": "[Circular Reference]"
    },
    "primary": true,
    "notes": "text",
    "statistics": {
      "subscriptions": 1,
      "agreements": 1
    }
  },
  "authorization": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "currency": "text",
    "notes": "text",
    "product": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "status": "text",
      "vendor": "[Circular Reference]",
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    },
    "vendor": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "owner": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text"
    },
    "statistics": {
      "subscriptions": 1,
      "agreements": 1,
      "sellers": 1,
      "listings": 1
    }
  },
  "vendor": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      "[Circular Reference]"
    ]
  },
  "client": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      "[Circular Reference]"
    ]
  },
  "price": {
    "currency": "text",
    "markup": 1,
    "margin": 1,
    "SPxY": 1,
    "SPxM": 1,
    "PPxY": 1,
    "PPxM": 1
  },
  "startDate": "2025-04-01T21:45:51.678Z",
  "endDate": "2025-04-01T21:45:51.678Z",
  "template": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "content": "text",
    "type": "OrderProcessing",
    "default": true,
    "product": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "status": "text",
      "vendor": "[Circular Reference]",
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    }
  },
  "error": {
    "id": "text",
    "message": "text",
    "parameters": null
  },
  "name": "text",
  "lines": [
    {
      "id": "text",
      "quantity": 1,
      "item": "[Circular Reference]",
      "audit": "[Circular Reference]",
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "PPx1": 1,
        "SPx1": 1
      },
      "order": "[Circular Reference]",
      "status": "Active"
    }
  ],
  "subscriptions": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "startDate": "2025-04-01T21:45:51.678Z",
      "terminationDate": "2025-04-01T21:45:51.678Z",
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "agreement": "[Circular Reference]",
      "terms": {
        "period": "1m",
        "commitment": "1m"
      },
      "product": "[Circular Reference]",
      "autoRenew": true,
      "status": "Active",
      "commitmentDate": "2025-04-01T21:45:51.678Z",
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1,
        "defaultMarkup": 1,
        "defaultMargin": 1
      },
      "parameters": {
        "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
          }
        ]
      },
      "buyer": "[Circular Reference]",
      "licensee": "[Circular Reference]",
      "seller": "[Circular Reference]",
      "split": "[Circular Reference]",
      "splitStatus": "Disabled",
      "lines": "[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
      }
    ]
  },
  "licensee": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "contact": {
      "firstName": "text",
      "lastName": "text",
      "email": "[e-mail]",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "user": "[Circular Reference]",
      "type": "text"
    },
    "name": "text",
    "externalId": "text",
    "status": "Active",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "useBuyerAddress": true,
    "description": "text",
    "account": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "buyer": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "contact": "[Circular Reference]",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "status": "Active",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "taxId": "text",
      "account": "[Circular Reference]",
      "name": "text",
      "errors": [
        {
          "id": "text",
          "message": "text",
          "parameters": null
        }
      ],
      "sellers": "[Circular Reference]"
    },
    "seller": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text"
    }
  },
  "buyer": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "activated": "[Circular Reference]",
      "unassigned": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "contact": {
      "firstName": "text",
      "lastName": "text",
      "email": "[e-mail]",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "user": "[Circular Reference]",
      "type": "text"
    },
    "externalIds": {
      "erpCompanyContact": "text",
      "erpCustomer": "text",
      "accountExternalId": "text"
    },
    "status": "Active",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "taxId": "text",
    "account": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "name": "text",
    "errors": [
      {
        "id": "text",
        "message": "text",
        "parameters": null
      }
    ],
    "sellers": [
      "[Circular Reference]"
    ]
  },
  "seller": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalId": "text",
    "status": "Active",
    "icon": "text",
    "currencies": [
      "text"
    ],
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "name": "text"
  },
  "product": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "published": "[Circular Reference]",
      "pending": "[Circular Reference]",
      "unpublished": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text"
    },
    "website": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "terminationOrder": true,
        "productRequest": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1,
      "requestCount": 1
    }
  },
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "split": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "allocations": [
      "[Circular Reference]"
    ]
  },
  "termsAndConditions": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "displayOrder": 1,
      "status": "text",
      "product": "[Circular Reference]",
      "accepted": "2025-04-01T21:45:51.678Z",
      "acceptedBy": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "icon": "text"
      }
    }
  ]
}

OK