Update Agreement

Updates an existing agreement

put

Path parameters

idstringRequired

Id of existing agreement to update

Body

application/jsontext/jsonapplication/*+json

idstringOptional

iconstring | nullableOptional

statusstring · enumOptionalPossible values:

listingall ofOptional

authorizationall ofOptional

vendorall ofOptional

clientall ofOptional

startDatestring · date-time | nullableOptional

endDatestring · date-time | nullableOptional

templateall ofOptional

namestringOptional

licenseeall ofOptional

buyerall ofOptional

sellerall ofOptional

productall ofOptional

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

put

HTTPcURLJavaScriptPython

PUT /public/v1/commerce/agreements/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 5123

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "provisioning": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminated": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$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-05-18T05:59:40.492Z",
  "endDate": "2025-05-18T05:59:40.492Z",
  "template": {
    "id": "text",
    "name": "text"
  },
  "error": {
    "id": "text",
    "message": "text",
    "parameters": null
  },
  "name": "text",
  "lines": [
    {
      "id": "text",
      "quantity": 1,
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "terminated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "deleted": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "PPx1": 1,
        "SPx1": 1
      },
      "order": {
        "id": "text"
      },
      "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",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "split": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-05-18T05:59:40.492Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-05-18T05:59:40.492Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": {
          "created": {
            "at": "2025-05-18T05:59:40.492Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-05-18T05:59:40.492Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "statistics": {
          "subscriptions": 1
        },
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        }
      }
    ]
  },
  "termsAndConditions": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "published": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "pending": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unpublished": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "displayOrder": 1,
      "status": "text",
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "accepted": "2025-05-18T05:59:40.492Z",
      "acceptedBy": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "icon": "text"
      }
    }
  ],
  "certificates": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "provisioning": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "terminated": {
      "at": "2025-05-18T05:59:40.492Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$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-05-18T05:59:40.492Z",
  "endDate": "2025-05-18T05:59:40.492Z",
  "template": {
    "id": "text",
    "name": "text"
  },
  "error": {
    "id": "text",
    "message": "text",
    "parameters": null
  },
  "name": "text",
  "lines": [
    {
      "id": "text",
      "quantity": 1,
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      },
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "terminated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "deleted": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "PPx1": 1,
        "SPx1": 1
      },
      "order": {
        "id": "text"
      },
      "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",
    "erpLink": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "blocked": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unblocked": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "split": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-05-18T05:59:40.492Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-05-18T05:59:40.492Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": {
          "created": {
            "at": "2025-05-18T05:59:40.492Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-05-18T05:59:40.492Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "statistics": {
          "subscriptions": 1
        },
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        }
      }
    ]
  },
  "termsAndConditions": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "published": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "pending": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "unpublished": {
          "at": "2025-05-18T05:59:40.492Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text"
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "displayOrder": 1,
      "status": "text",
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "accepted": "2025-05-18T05:59:40.492Z",
      "acceptedBy": {
        "id": "text",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "icon": "text"
      }
    }
  ],
  "certificates": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}