<commit_before>---
title: Budget Tracking
layout: reference
---

## Menu

* [Getting Started](./getting-started.html)
* [Fiscal Year](/api-reference/budget/fiscal-year.html)
* [Budget Category](/api-reference/budget/budget-category.html)
* [Budget Item](/api-reference/budget/budget-header.html)
* [Budget Tracking Field](/api-reference/budget/budget-tracking.html)
* [Budget Adjustments](/api-reference/budget/budget-adjustments.html)

**Preview** _This is a prerelease version of the service and is subject to change before final release._

This resource is used to retrieve information about budget's tracking fields for an entity. Every entity may have a specific set of budget tracking fields and every budget may enable any or all of the budget tracking fields. If there are tracking fields associated, the budgets get matched to the Product only when the tracking field conditions are met. 

* [GET all budget tracking fields for an entity](#getall)
* [Schema](#schema)
  * [Budget Tracking Field](#budgetTracking)
* [Response Headers](#responseHeaders)

## Version

4.0

## <a name="getall"></a>GET all Budget Tracking Fields

Retrieve budget tracking fields for use in budget configuration. The budget sequence number from this response may be used as the "code" field in the budget item header tracking fields.

### Scopes

Name|Description
---|---
`budgetitem.write`|Create/update/delete access to budget data
`budgetitem.read`|Read access to budget data

### Request

#### Headers

* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)

#### Parameters

N/A

##### URI Template

```shell
GET /budget/v4/budgetTrackingField
```

### Response

#### Status Codes

* [200 OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) Successful call, response is in body.
* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) The request was determined to be invalid by the server. Possibly a validation failed on the data that was sent in the payload. The response will have a list of validation errors in the body. See below for an example 400 response.
* [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3) The user does not have the necessary permissions to perform the request.
* [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) The resource could not be found or does not exist
* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) Error message in response body
* [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5) Error message in response body

#### Headers

[Response Headers](#responseHeaders)

#### Payload

Array of [Budget Tracking Field](#budgetTracking)

### Example

#### Request

```shell
GET https://us.api.concursolutions.com/budget/v4/budgetTrackingField
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json
```

#### Response

```shell
HTTP/1.1 200 OK
Cache-Control: no-store
Connection: keep-alive
Content-Length: 1371
Content-Type: application/json;charset=utf-8
Date: Fri, 21 Sep 2018 15:24:27 GMT
Expires: Thu, 20 Sep 2018 15:24:27 GMT
Pragma: no-cache
Vary: Origin
concur-correlationid: 86a0d9fe-9e98-43c3-89d8-a2917dd844cb
```

```json
[
   {
        "budgetTrackingFieldName": "Cost Center",
        "fieldType": "LIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E20840CE9B",
        "fieldId": "86309e0c-913c-47a5-9bcf-24a05342c718",
        "budgetSequenceNumber": 2
    },
    {
        "budgetTrackingFieldName": "Company",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "d8f911a1-f298-4c65-b06b-710d482c9c46",
        "budgetSequenceNumber": 1
    },
    {
        "budgetTrackingFieldName": "Department",
        "fieldType": "LIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E2084Q412",
        "fieldId": "c4f721cb-8fc9-48cf-993e-5ea0edefcdbd",
        "budgetSequenceNumber": 3
    },
    {
        "budgetTrackingFieldName": "Vendor",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "bcc7ba39-a3a0-4267-84f4-1d5b439cce65",
        "budgetSequenceNumber": 5
    },
    {
        "budgetTrackingFieldName": "Region",
        "fieldType": "MLIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E20840CE9B",
        "fieldId": "a2502b74-e3ce-4b30-a3a4-b6ceb68cf677",
        "budgetSequenceNumber": 6
    },
    {
        "budgetTrackingFieldName": "Country",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "4ac122ad-8c0b-4076-bd41-49b09d576d5b",
        "budgetSequenceNumber": 4
    }
]
```

## <a name="schema"></a>Schema

### <a name="budgetTracking"></a>Budget Tracking Field

Name|Type|Format|Description
---|---|---|---
`budgetTrackingFieldName`|`string`|-|The budget field tracking name 
`fieldType`|`string`|-|The data type of this field or field collection. Valid values are LIST, MLIST, and VARCHAR.
`listSyncGuid`|`string`|-|If the dataType of this item is LIST or MLIST, this is the id of the list definition from Concur's list service.
`fieldId`|`string`|-|The budget service's key for this object
`budgetSequenceNumber`|`integer`|-|The sequence or the order in which the budget tracking field appears in the budget UI.

## <a name="responseHeaders"></a>Response Headers

* `concur-correlationid` is a Concur specific custom header used for technical support in the form of a [RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace](https://tools.ietf.org/html/rfc4122)
* [RFC 7231 Allow](https://tools.ietf.org/html/rfc7231#section-7.4.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Date](https://tools.ietf.org/html/rfc7231#section-7.1.1.2)
* [RFC 7234 Expires](https://tools.ietf.org/html/rfc7234#section-5.3)
* [RFC 7232 ETag](https://tools.ietf.org/html/rfc7232#section-2.3)<commit_msg>BUD-1340 - changing "Concur" to "SAP Concur" in two spots.<commit_after>---
title: Budget Tracking
layout: reference
---

## Menu

* [Getting Started](./getting-started.html)
* [Fiscal Year](/api-reference/budget/fiscal-year.html)
* [Budget Category](/api-reference/budget/budget-category.html)
* [Budget Item](/api-reference/budget/budget-header.html)
* [Budget Tracking Field](/api-reference/budget/budget-tracking.html)
* [Budget Adjustments](/api-reference/budget/budget-adjustments.html)

**Preview** _This is a prerelease version of the service and is subject to change before final release._

This resource is used to retrieve information about budget's tracking fields for an entity. Every entity may have a specific set of budget tracking fields and every budget may enable any or all of the budget tracking fields. If there are tracking fields associated, the budgets get matched to the Product only when the tracking field conditions are met. 

* [GET all budget tracking fields for an entity](#getall)
* [Schema](#schema)
  * [Budget Tracking Field](#budgetTracking)
* [Response Headers](#responseHeaders)

## Version

4.0

## <a name="getall"></a>GET all Budget Tracking Fields

Retrieve budget tracking fields for use in budget configuration. The budget sequence number from this response may be used as the "code" field in the budget item header tracking fields.

### Scopes

Name|Description
---|---
`budgetitem.write`|Create/update/delete access to budget data
`budgetitem.read`|Read access to budget data

### Request

#### Headers

* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)

#### Parameters

N/A

##### URI Template

```shell
GET /budget/v4/budgetTrackingField
```

### Response

#### Status Codes

* [200 OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) Successful call, response is in body.
* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) The request was determined to be invalid by the server. Possibly a validation failed on the data that was sent in the payload. The response will have a list of validation errors in the body. See below for an example 400 response.
* [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3) The user does not have the necessary permissions to perform the request.
* [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) The resource could not be found or does not exist
* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) Error message in response body
* [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5) Error message in response body

#### Headers

[Response Headers](#responseHeaders)

#### Payload

Array of [Budget Tracking Field](#budgetTracking)

### Example

#### Request

```shell
GET https://us.api.concursolutions.com/budget/v4/budgetTrackingField
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json
```

#### Response

```shell
HTTP/1.1 200 OK
Cache-Control: no-store
Connection: keep-alive
Content-Length: 1371
Content-Type: application/json;charset=utf-8
Date: Fri, 21 Sep 2018 15:24:27 GMT
Expires: Thu, 20 Sep 2018 15:24:27 GMT
Pragma: no-cache
Vary: Origin
concur-correlationid: 86a0d9fe-9e98-43c3-89d8-a2917dd844cb
```

```json
[
   {
        "budgetTrackingFieldName": "Cost Center",
        "fieldType": "LIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E20840CE9B",
        "fieldId": "86309e0c-913c-47a5-9bcf-24a05342c718",
        "budgetSequenceNumber": 2
    },
    {
        "budgetTrackingFieldName": "Company",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "d8f911a1-f298-4c65-b06b-710d482c9c46",
        "budgetSequenceNumber": 1
    },
    {
        "budgetTrackingFieldName": "Department",
        "fieldType": "LIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E2084Q412",
        "fieldId": "c4f721cb-8fc9-48cf-993e-5ea0edefcdbd",
        "budgetSequenceNumber": 3
    },
    {
        "budgetTrackingFieldName": "Vendor",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "bcc7ba39-a3a0-4267-84f4-1d5b439cce65",
        "budgetSequenceNumber": 5
    },
    {
        "budgetTrackingFieldName": "Region",
        "fieldType": "MLIST",
        "listSyncGuid": "8652CDF9C12B4051B8D180E20840CE9B",
        "fieldId": "a2502b74-e3ce-4b30-a3a4-b6ceb68cf677",
        "budgetSequenceNumber": 6
    },
    {
        "budgetTrackingFieldName": "Country",
        "fieldType": "VARCHAR",
        "listSyncGuid": null,
        "fieldId": "4ac122ad-8c0b-4076-bd41-49b09d576d5b",
        "budgetSequenceNumber": 4
    }
]
```

## <a name="schema"></a>Schema

### <a name="budgetTracking"></a>Budget Tracking Field

Name|Type|Format|Description
---|---|---|---
`budgetTrackingFieldName`|`string`|-|The budget field tracking name 
`fieldType`|`string`|-|The data type of this field or field collection. Valid values are LIST, MLIST, and VARCHAR.
`listSyncGuid`|`string`|-|If the dataType of this item is LIST or MLIST, this is the id of the list definition from SAP Concur's list service.
`fieldId`|`string`|-|The budget service's key for this object
`budgetSequenceNumber`|`integer`|-|The sequence or the order in which the budget tracking field appears in the budget UI.

## <a name="responseHeaders"></a>Response Headers

* `concur-correlationid` is a SAP Concur specific custom header used for technical support in the form of a [RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace](https://tools.ietf.org/html/rfc4122)
* [RFC 7231 Allow](https://tools.ietf.org/html/rfc7231#section-7.4.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Date](https://tools.ietf.org/html/rfc7231#section-7.1.1.2)
* [RFC 7234 Expires](https://tools.ietf.org/html/rfc7234#section-5.3)
* [RFC 7232 ETag](https://tools.ietf.org/html/rfc7232#section-2.3)
{'fraction_non_alphanumeric': 0.1381197418933268, 'fraction_numerical': 0.06763048272482235, 'mean_word_length': 4.10805173133083, 'pattern_counts': {'":': 60, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 34, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 6, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6979950', 'n_tokens_mistral': 4687, 'n_tokens_neox': 4177, 'n_words': 1035}