List Agreement Attachments

get
Path parameters
agreementIdstringRequired
Responses
200

OK

application/json
get
GET /public/v1/commerce/agreements/{agreementId}/attachments HTTP/1.1
Host: api.s1.today
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-09-16T11:54:38.690Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2025-09-16T11:54:38.690Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "revision": 1,
      "type": "text",
      "description": "text",
      "filename": "text",
      "size": 1,
      "contentType": "text",
      "orderId": "text",
      "licenseKey": "text",
      "agreement": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-09-16T11:54:38.690Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2025-09-16T11:54:38.690Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "active": {
            "at": "2025-09-16T11:54:38.690Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "provisioning": {
            "at": "2025-09-16T11:54:38.690Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "terminated": {
            "at": "2025-09-16T11:54:38.690Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "status": "New",
        "listing": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "revision": 1,
          "name": "text",
          "authorization": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "revision": 1,
            "externalIds": {
              "operations": "text"
            },
            "currency": "text",
            "notes": "text",
            "product": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "published": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "pending": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "unpublished": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "shortDescription": "text",
              "longDescription": "text",
              "externalIds": {
                "operations": "text",
                "defaultErpItem": "text"
              },
              "website": "text",
              "status": "text",
              "vendor": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1,
                "type": "Client",
                "status": "Active"
              },
              "settings": {
                "productOrdering": true,
                "productRequests": {
                  "enabled": true,
                  "name": "text",
                  "label": "text"
                },
                "itemSelection": true,
                "orderQueueChanges": true,
                "preValidation": {
                  "purchaseOrderDraft": true,
                  "purchaseOrderQuerying": true,
                  "changeOrderDraft": true,
                  "configurationOrderDraft": true,
                  "terminationOrder": true,
                  "productRequest": true
                },
                "splitBilling": {
                  "enabled": true,
                  "type": "text"
                },
                "subscriptionCessation": {
                  "enabled": true,
                  "mode": "Termination"
                }
              },
              "statistics": {
                "itemCount": 1,
                "ordersPlacedCount": 1,
                "agreementCount": 1,
                "subscriptionCount": 1,
                "requestCount": 1
              }
            },
            "vendor": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active",
              "externalIds": {
                "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
              },
              "externalId": "text",
              "externalName": "text",
              "address": {
                "addressLine1": "text",
                "addressLine2": "text",
                "postCode": "text",
                "city": "text",
                "state": "text",
                "country": "text"
              },
              "technicalSupportEmail": "[email protected]",
              "website": "text",
              "description": "text",
              "groups": [
                {
                  "id": "text",
                  "name": "text",
                  "revision": 1,
                  "description": "text",
                  "logo": "text",
                  "isDefault": true
                }
              ],
              "eligibility": {
                "client": true,
                "partner": true
              }
            },
            "owner": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "externalId": "text",
              "status": "Active",
              "currencies": [
                "text"
              ],
              "address": {
                "addressLine1": "text",
                "addressLine2": "text",
                "postCode": "text",
                "city": "text",
                "state": "text",
                "country": "text"
              },
              "erpLink": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1,
                "companyName": "text",
                "status": "Active"
              }
            },
            "statistics": {
              "subscriptions": 1,
              "agreements": 1,
              "sellers": 1,
              "listings": 1
            },
            "journal": {
              "firstInvoiceDate": "2025-09-16T11:54:38.690Z",
              "frequency": "1m"
            },
            "eligibility": {
              "client": true,
              "partner": true
            }
          },
          "product": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "externalIds": {
              "operations": "text",
              "defaultErpItem": "text"
            },
            "status": "text"
          },
          "vendor": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          },
          "seller": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "externalId": "text"
          },
          "priceList": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "revision": 1,
            "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": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "published": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "pending": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "unpublished": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "shortDescription": "text",
              "longDescription": "text",
              "externalIds": {
                "operations": "text",
                "defaultErpItem": "text"
              },
              "website": "text",
              "status": "text",
              "vendor": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1,
                "type": "Client",
                "status": "Active"
              },
              "settings": {
                "productOrdering": true,
                "productRequests": {
                  "enabled": true,
                  "name": "text",
                  "label": "text"
                },
                "itemSelection": true,
                "orderQueueChanges": true,
                "preValidation": {
                  "purchaseOrderDraft": true,
                  "purchaseOrderQuerying": true,
                  "changeOrderDraft": true,
                  "configurationOrderDraft": true,
                  "terminationOrder": true,
                  "productRequest": true
                },
                "splitBilling": {
                  "enabled": true,
                  "type": "text"
                },
                "subscriptionCessation": {
                  "enabled": true,
                  "mode": "Termination"
                }
              },
              "statistics": {
                "itemCount": 1,
                "ordersPlacedCount": 1,
                "agreementCount": 1,
                "subscriptionCount": 1,
                "requestCount": 1
              }
            },
            "vendor": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active",
              "externalIds": {
                "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
              },
              "externalId": "text",
              "externalName": "text",
              "address": {
                "addressLine1": "text",
                "addressLine2": "text",
                "postCode": "text",
                "city": "text",
                "state": "text",
                "country": "text"
              },
              "technicalSupportEmail": "[email protected]",
              "website": "text",
              "description": "text",
              "groups": [
                {
                  "id": "text",
                  "name": "text",
                  "revision": 1,
                  "description": "text",
                  "logo": "text",
                  "isDefault": true
                }
              ],
              "eligibility": {
                "client": true,
                "partner": true
              }
            }
          },
          "primary": true,
          "notes": "text",
          "statistics": {
            "subscriptions": 1,
            "agreements": 1
          },
          "eligibility": {
            "client": true,
            "partner": true
          }
        },
        "authorization": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "revision": 1,
          "externalIds": {
            "operations": "text"
          },
          "currency": "text",
          "notes": "text",
          "product": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "published": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "pending": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "unpublished": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "shortDescription": "text",
            "longDescription": "text",
            "externalIds": {
              "operations": "text",
              "defaultErpItem": "text"
            },
            "website": "text",
            "status": "text",
            "vendor": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            },
            "settings": {
              "productOrdering": true,
              "productRequests": {
                "enabled": true,
                "name": "text",
                "label": "text"
              },
              "itemSelection": true,
              "orderQueueChanges": true,
              "preValidation": {
                "purchaseOrderDraft": true,
                "purchaseOrderQuerying": true,
                "changeOrderDraft": true,
                "configurationOrderDraft": true,
                "terminationOrder": true,
                "productRequest": true
              },
              "splitBilling": {
                "enabled": true,
                "type": "text"
              },
              "subscriptionCessation": {
                "enabled": true,
                "mode": "Termination"
              }
            },
            "statistics": {
              "itemCount": 1,
              "ordersPlacedCount": 1,
              "agreementCount": 1,
              "subscriptionCount": 1,
              "requestCount": 1
            }
          },
          "vendor": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active",
            "externalIds": {
              "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
            },
            "externalId": "text",
            "externalName": "text",
            "address": {
              "addressLine1": "text",
              "addressLine2": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "technicalSupportEmail": "[email protected]",
            "website": "text",
            "description": "text",
            "groups": [
              {
                "id": "text",
                "name": "text",
                "revision": 1,
                "description": "text",
                "logo": "text",
                "isDefault": true
              }
            ],
            "eligibility": {
              "client": true,
              "partner": true
            }
          },
          "owner": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "externalId": "text",
            "status": "Active",
            "currencies": [
              "text"
            ],
            "address": {
              "addressLine1": "text",
              "addressLine2": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "erpLink": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "companyName": "text",
              "status": "Active"
            }
          },
          "statistics": {
            "subscriptions": 1,
            "agreements": 1,
            "sellers": 1,
            "listings": 1
          },
          "journal": {
            "firstInvoiceDate": "2025-09-16T11:54:38.690Z",
            "frequency": "1m"
          },
          "eligibility": {
            "client": true,
            "partner": true
          }
        },
        "vendor": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "[email protected]",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          }
        },
        "client": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "[email protected]",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          }
        },
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "defaultMarkupSource": {
            "type": "text",
            "ref": {
              "id": "text",
              "name": "text"
            }
          },
          "markupSource": {
            "type": "text",
            "ref": {
              "id": "text",
              "name": "text"
            }
          },
          "SPxY": 1,
          "SPxM": 1,
          "PPxY": 1,
          "PPxM": 1,
          "defaultMarkup": 1,
          "defaultMargin": 1
        },
        "startDate": "2025-09-16T11:54:38.690Z",
        "endDate": "2025-09-16T11:54:38.690Z",
        "template": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "revision": 1,
          "content": "text",
          "type": "OrderProcessing",
          "default": true,
          "product": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "externalIds": {
              "operations": "text",
              "defaultErpItem": "text"
            },
            "status": "text"
          }
        },
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "lines": [
          "[Circular Reference]"
        ],
        "assets": [
          "[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
            }
          ]
        },
        "licensee": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "disabled": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "externalId": "text",
          "status": "Active",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "useBuyerAddress": true,
          "description": "text",
          "account": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          },
          "buyer": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          },
          "seller": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "externalId": "text"
          },
          "eligibility": {
            "client": true,
            "partner": true
          }
        },
        "buyer": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "activated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "unassigned": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "disabled": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "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",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          },
          "errors": [
            {
              "id": "text",
              "message": "text",
              "parameters": null
            }
          ],
          "sellers": [
            {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "externalId": "text"
            }
          ]
        },
        "seller": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "externalId": "text",
          "status": "Active",
          "currencies": [
            "text"
          ],
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "erpLink": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "companyName": "text",
            "status": "Active"
          }
        },
        "product": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "published": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "pending": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "unpublished": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "shortDescription": "text",
          "longDescription": "text",
          "externalIds": {
            "operations": "text",
            "defaultErpItem": "text"
          },
          "website": "text",
          "status": "text",
          "vendor": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          },
          "settings": {
            "productOrdering": true,
            "productRequests": {
              "enabled": true,
              "name": "text",
              "label": "text"
            },
            "itemSelection": true,
            "orderQueueChanges": true,
            "preValidation": {
              "purchaseOrderDraft": true,
              "purchaseOrderQuerying": true,
              "changeOrderDraft": true,
              "configurationOrderDraft": true,
              "terminationOrder": true,
              "productRequest": true
            },
            "splitBilling": {
              "enabled": true,
              "type": "text"
            },
            "subscriptionCessation": {
              "enabled": true,
              "mode": "Termination"
            }
          },
          "statistics": {
            "itemCount": 1,
            "ordersPlacedCount": 1,
            "agreementCount": 1,
            "subscriptionCount": 1,
            "requestCount": 1
          }
        },
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        },
        "split": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2025-09-16T11:54:38.690Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "revision": 1,
          "allocations": [
            {
              "buyer": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              },
              "percentage": 1,
              "price": {
                "currency": "text",
                "SPxY": 1,
                "SPxM": 1,
                "PPxY": 1,
                "PPxM": 1
              },
              "audit": {
                "created": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2025-09-16T11:54:38.690Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "statistics": {
                "subscriptions": 1
              },
              "externalIds": {
                "client": "text",
                "operations": "text",
                "vendor": "text"
              }
            }
          ]
        },
        "termsAndConditions": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "published": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "pending": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "unpublished": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "revision": 1,
            "description": "text",
            "displayOrder": 1,
            "status": "text",
            "product": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "externalIds": {
                "operations": "text",
                "defaultErpItem": "text"
              },
              "status": "text"
            },
            "accepted": "2025-09-16T11:54:38.690Z",
            "acceptedBy": {
              "id": "text",
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "firstName": "text",
              "lastName": "text",
              "email": "text"
            }
          }
        ],
        "certificates": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "activated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "pending": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "terminated": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "expired": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updating": {
                "at": "2025-09-16T11:54:38.690Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "revision": 1,
            "program": {
              "id": "text",
              "name": "text",
              "revision": 1,
              "status": "None",
              "applicableTo": "Buyer",
              "products": [
                {
                  "id": "text",
                  "audit": {
                    "created": {
                      "at": "2025-09-16T11:54:38.690Z",
                      "by": {
                        "id": "text",
                        "name": "text",
                        "icon": "text",
                        "revision": 1
                      }
                    },
                    "updated": {
                      "at": "2025-09-16T11:54:38.690Z",
                      "by": {
                        "id": "text",
                        "name": "text",
                        "icon": "text",
                        "revision": 1
                      }
                    },
                    "published": {
                      "at": "2025-09-16T11:54:38.690Z",
                      "by": {
                        "id": "text",
                        "name": "text",
                        "icon": "text",
                        "revision": 1
                      }
                    },
                    "pending": {
                      "at": "2025-09-16T11:54:38.690Z",
                      "by": {
                        "id": "text",
                        "name": "text",
                        "icon": "text",
                        "revision": 1
                      }
                    },
                    "unpublished": {
                      "at": "2025-09-16T11:54:38.690Z",
                      "by": {
                        "id": "text",
                        "name": "text",
                        "icon": "text",
                        "revision": 1
                      }
                    }
                  },
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "name": "text",
                  "icon": "text",
                  "revision": 1,
                  "shortDescription": "text",
                  "longDescription": "text",
                  "externalIds": {
                    "operations": "text",
                    "defaultErpItem": "text"
                  },
                  "website": "text",
                  "status": "text",
                  "vendor": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1,
                    "type": "Client",
                    "status": "Active"
                  },
                  "settings": {
                    "productOrdering": true,
                    "productRequests": {
                      "enabled": true,
                      "name": "text",
                      "label": "text"
                    },
                    "itemSelection": true,
                    "orderQueueChanges": true,
                    "preValidation": {
                      "purchaseOrderDraft": true,
                      "purchaseOrderQuerying": true,
                      "changeOrderDraft": true,
                      "configurationOrderDraft": true,
                      "terminationOrder": true,
                      "productRequest": true
                    },
                    "splitBilling": {
                      "enabled": true,
                      "type": "text"
                    },
                    "subscriptionCessation": {
                      "enabled": true,
                      "mode": "Termination"
                    }
                  },
                  "statistics": {
                    "itemCount": 1,
                    "ordersPlacedCount": 1,
                    "agreementCount": 1,
                    "subscriptionCount": 1,
                    "requestCount": 1
                  }
                }
              ]
            },
            "externalIds": {
              "vendor": "text"
            },
            "client": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            },
            "applicableTo": "Buyer",
            "buyer": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            },
            "licensee": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "externalId": "text"
            },
            "eligibility": {
              "client": true,
              "partner": true
            },
            "status": "Pending",
            "expirationDate": "2025-09-16",
            "template": {
              "id": "text",
              "name": "text",
              "revision": 1,
              "type": "EnrollmentProcessing"
            },
            "parameters": {
              "ordering": [
                {
                  "id": "text",
                  "externalId": "text",
                  "name": "text",
                  "type": "SingleLineText",
                  "phase": "Order",
                  "error": {
                    "id": "text",
                    "message": "text",
                    "parameters": null
                  },
                  "constraints": {
                    "hidden": true,
                    "readonly": true,
                    "required": true
                  },
                  "displayValue": "text",
                  "value": null
                }
              ],
              "fulfillment": [
                {
                  "id": "text",
                  "externalId": "text",
                  "name": "text",
                  "type": "SingleLineText",
                  "phase": "Order",
                  "error": {
                    "id": "text",
                    "message": "text",
                    "parameters": null
                  },
                  "constraints": {
                    "hidden": true,
                    "readonly": true,
                    "required": true
                  },
                  "displayValue": "text",
                  "value": null
                }
              ]
            },
            "terms": [
              {
                "id": "text",
                "name": "text",
                "revision": 1,
                "accepted": "2025-09-16T11:54:38.690Z",
                "acceptedBy": {
                  "id": "text",
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "name": "text",
                  "icon": "text",
                  "revision": 1,
                  "firstName": "text",
                  "lastName": "text",
                  "email": "text"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Last updated

Was this helpful?