> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Get Sale

- Component: `appmixer.superoffice.core.GetSale`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.superoffice 1.2.0](https://connectors.appmixer.com/connector/appmixer.superoffice/1.2.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.superoffice/1.2.0/component/appmixer.superoffice.core.GetSale>

Get a sale by its ID.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Sale ID (`saleId`) | text | The ID of the sale. Use Find Sales to look it up. |
| Time Zone (`timeZone`) | text | Optional. The time zone of your SuperOffice tenant, for example Europe/Oslo. SuperOffice keeps date-times in the local time of the tenant; the time zone is detected automatically (reliably for European tenants) and this setting overrides it. Date-times the component returns are always in UTC. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Sale ID (`id`) | integer | - |
| Heading (`heading`) | string | - |
| Amount (`amount`) | number | - |
| Sale Date (`saleDate`) | string | - |
| Status (`status`) | string | - |
| Probability (`probability`) | integer | - |
| Sale Type (`saleType`) | string | - |
| Company ID (`companyId`) | integer | - |
| Company Name (`companyName`) | string | - |
| Person ID (`personId`) | integer | - |
| Person Name (`personName`) | string | - |
| Project ID (`projectId`) | integer | - |
| Description (`description`) | string | - |
| Created Date (`createdDate`) | string | - |
| Updated Date (`updatedDate`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.superoffice.core.GetSale",
  "label": "Get Sale",
  "description": "Get a sale by its ID.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:superoffice"
  },
  "quota": {
    "manager": "appmixer:superoffice",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "saleId": {
            "type": "string"
          },
          "timeZone": {
            "type": "string"
          }
        },
        "required": [
          "saleId"
        ]
      },
      "inspector": {
        "inputs": {
          "saleId": {
            "type": "text",
            "index": 1,
            "label": "Sale ID",
            "tooltip": "The ID of the sale. Use Find Sales to look it up."
          },
          "timeZone": {
            "type": "text",
            "index": 2,
            "label": "Time Zone",
            "tooltip": "Optional. The time zone of your SuperOffice tenant, for example Europe/Oslo. SuperOffice keeps date-times in the local time of the tenant; the time zone is detected automatically (reliably for European tenants) and this setting overrides it. Date-times the component returns are always in UTC.",
            "source": {
              "url": "/component/appmixer/superoffice/core/ListTimeZones?outPort=out",
              "data": {
                "transform": "./ListTimeZones#toSelectArray"
              }
            }
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "title": "Sale ID",
            "example": 57
          },
          "heading": {
            "type": "string",
            "title": "Heading",
            "example": "50 licences"
          },
          "amount": {
            "type": "number",
            "title": "Amount",
            "example": 12500
          },
          "saleDate": {
            "type": "string",
            "title": "Sale Date",
            "example": "2026-12-15T00:00:00Z"
          },
          "status": {
            "type": "string",
            "title": "Status",
            "example": "Open"
          },
          "probability": {
            "type": "integer",
            "title": "Probability",
            "example": 50
          },
          "saleType": {
            "type": "string",
            "title": "Sale Type",
            "example": "New business"
          },
          "companyId": {
            "type": "integer",
            "title": "Company ID",
            "example": 125
          },
          "companyName": {
            "type": "string",
            "title": "Company Name",
            "example": "Acme Inc."
          },
          "personId": {
            "type": "integer",
            "title": "Person ID",
            "example": 342
          },
          "personName": {
            "type": "string",
            "title": "Person Name",
            "example": "Jane Doe"
          },
          "projectId": {
            "type": "integer",
            "title": "Project ID",
            "example": 12
          },
          "description": {
            "type": "string",
            "title": "Description",
            "example": "Renewal of the yearly licence."
          },
          "createdDate": {
            "type": "string",
            "title": "Created Date",
            "example": "2026-11-16T10:30:00Z"
          },
          "updatedDate": {
            "type": "string",
            "title": "Updated Date",
            "example": "2026-11-17T08:15:00Z"
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
