---
title: "CollectionResponse"
url: "https://developer.tesma.com/apis/tesma-platform-api-v1/versions/333907fb-f0a7-4e20-b01e-c9915c73321a/schemas/CollectionResponse"
---

> Full API specification: https://developer.tesma.com/apis/tesma-platform-api-v1/versions/333907fb-f0a7-4e20-b01e-c9915c73321a.md

# CollectionResponse

## OpenAPI definition

```yaml
openapi: 3.1.1
info:
  title: tesma
  version: v1
servers:
  - url: https://api.tesma.com
components:
  schemas:
    AddressResponse:
      additionalProperties: false
      properties:
        city:
          type:
            - "null"
            - string
        country:
          type:
            - "null"
            - string
        county:
          type:
            - "null"
            - string
        customerContext:
          $ref: "#/components/schemas/CustomerContextResponse"
        name:
          type:
            - "null"
            - string
        number:
          format: int32
          type:
            - "null"
            - integer
        postalCode:
          type:
            - "null"
            - string
        street:
          type:
            - "null"
            - string
        taxID:
          type:
            - "null"
            - string
      type: object
    CustomerContextResponse:
      additionalProperties: false
      properties:
        customerName:
          type:
            - "null"
            - string
        customerNumber:
          format: int32
          type: integer
        leaseCompany:
          format: int32
          type: integer
        leaseCompanyName:
          type:
            - "null"
            - string
      type: object
    CollectedAssetErasureType:
      enum:
        - eraSurePlus
        - eraSure
        - doDCompliant
        - noErasure
      type: string
    CollectionRequestPickupDateType:
      enum:
        - asapCollectionFromSpecificDate
        - fixedCollection
        - asapCollection
        - timeSlotCollection
      type: string
    CollectionStatus:
      enum:
        - created
        - scheduled
        - confirmed
        - dateArranged
        - collected
        - verified
        - completed
        - draft
        - requested
      type: string
    CollectionResponse:
      additionalProperties: false
      properties:
        carrierAddress:
          $ref: "#/components/schemas/AddressResponse"
        carrierAddressContact:
          type:
            - "null"
            - string
        carrierAddressMail:
          type:
            - "null"
            - string
        carrierAddressTelephone:
          type:
            - "null"
            - string
        collectionAddress:
          $ref: "#/components/schemas/AddressResponse"
        collectionAddressContact:
          type:
            - "null"
            - string
        collectionAddressMail:
          type:
            - "null"
            - string
        collectionAddressTelephone:
          type:
            - "null"
            - string
        collectionComment:
          type:
            - "null"
            - string
        collectionNumber:
          format: int32
          type: integer
        collectionRequestNumber:
          format: int32
          type: integer
        customerContext:
          $ref: "#/components/schemas/CustomerContextResponse"
        destinationAddressContact:
          type:
            - "null"
            - string
        effectiveCollection:
          format: date-time
          type:
            - "null"
            - string
        erasureType:
          $ref: "#/components/schemas/CollectedAssetErasureType"
        goodsIn:
          format: date-time
          type:
            - "null"
            - string
        numberOfCollectedAssets:
          format: int32
          type: integer
        numberOfGradeAAssets:
          format: int32
          type: integer
        numberOfGradeBAssets:
          format: int32
          type: integer
        numberOfGradeCAssets:
          format: int32
          type: integer
        numberOfGradeDAssets:
          format: int32
          type: integer
        numberOfPlannedAssets:
          format: int32
          type: integer
        plannedCollection:
          format: date-time
          type:
            - "null"
            - string
        plannedCollectionNote:
          type:
            - "null"
            - string
        preferredCollectionPickupDateType:
          $ref: "#/components/schemas/CollectionRequestPickupDateType"
        preferredCollectionTimestamp:
          format: date-time
          type:
            - "null"
            - string
        preferredCollectionTimestampTo:
          format: date-time
          type:
            - "null"
            - string
        recipientAddress:
          $ref: "#/components/schemas/AddressResponse"
        recipientComment:
          type:
            - "null"
            - string
        status:
          $ref: "#/components/schemas/CollectionStatus"
        transportOrderId:
          format: int32
          type: integer
        transportOrderNumber:
          type:
            - "null"
            - string
      type: object
```