---
title: "POST /api/v1/AgreementProducts/file/xlsx"
method: POST
path: "/api/v1/AgreementProducts/file/xlsx"
tags: ["AgreementProducts"]
---

# POST /api/v1/AgreementProducts/file/xlsx

`POST /api/v1/AgreementProducts/file/xlsx`

## Request

- Base URL: `https://api.crayon.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.crayon.com/api/v1/AgreementProducts/file/xlsx`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/crayon/apis/crayon-group-customer-api/docs/api/v1/AgreementProducts/file/xlsx/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- AgreementProductFilter
  - `agreementTypeIds` AgreementType[], nullable
  - `page` integer
  - `pageSize` integer
  - `search` string, nullable
  - `priceListId` integer
  - `organizationId` integer
  - `customerTenantId` integer
  - `agreementId` integer
  - `isTrial` boolean, nullable
  - `agreementIds` integer[], nullable
  - `searchDate` string, date-time, nullable
  - `include` AgreementProductsSubFilter
    - `partNumbers` string[], nullable
    - `publisherIds` integer[], nullable
    - `publisherNames` string[], nullable
    - `poolNames` string[], nullable
    - `operatingSystemNames` string[], nullable
    - `levelNames` string[], nullable
    - `languageNames` string[], nullable
    - `licenseAgreementTypeNames` string[], nullable
    - `licenseTypeNames` string[], nullable
    - `productFamilyNames` string[], nullable
    - `productTypeNames` string[], nullable
    - `programNames` string[], nullable
    - `offeringNames` string[], nullable
    - `purchasePeriodNames` string[], nullable
    - `purchaseUnitNames` string[], nullable
    - `versionNames` string[], nullable
    - `regionNames` string[], nullable
    - `productCategoryNames` string[], nullable
    - `catalogNames` string[], nullable
    - `billingCycles` string[], nullable
    - `attributesRegions` string[], nullable
    - `attributesVCpus` string[], nullable
    - `attributesRams` string[], nullable
    - `attributesCores` string[], nullable
    - `attributesCategories` string[], nullable
    - `attributesDiskSizes` string[], nullable
    - `attributesGroupNames` string[], nullable
  - `exclude` AgreementProductsSubFilter
    - `partNumbers` string[], nullable
    - `publisherIds` integer[], nullable
    - `publisherNames` string[], nullable
    - `poolNames` string[], nullable
    - `operatingSystemNames` string[], nullable
    - `levelNames` string[], nullable
    - `languageNames` string[], nullable
    - `licenseAgreementTypeNames` string[], nullable
    - `licenseTypeNames` string[], nullable
    - `productFamilyNames` string[], nullable
    - `productTypeNames` string[], nullable
    - `programNames` string[], nullable
    - `offeringNames` string[], nullable
    - `purchasePeriodNames` string[], nullable
    - `purchaseUnitNames` string[], nullable
    - `versionNames` string[], nullable
    - `regionNames` string[], nullable
    - `productCategoryNames` string[], nullable
    - `catalogNames` string[], nullable
    - `billingCycles` string[], nullable
    - `attributesRegions` string[], nullable
    - `attributesVCpus` string[], nullable
    - `attributesRams` string[], nullable
    - `attributesCores` string[], nullable
    - `attributesCategories` string[], nullable
    - `attributesDiskSizes` string[], nullable
    - `attributesGroupNames` string[], nullable
  - `sortKey` string, nullable
  - `includeProductInformation` boolean
  - `includeProductVariantInformation` boolean
  - `includeEndOfSale` boolean, nullable
  - `sortOrder` 0 | 1

## Response `200`

Success

---

[API](https://skmtc.dev/crayon/apis/crayon-group-customer-api.md) - [All operations](https://skmtc.dev/crayon/apis/crayon-group-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/crayon/apis/crayon-group-customer-api/revisions/55939d9eb11f?raw)