# Tax
# Tax
Property tax at parcel level: assessed values, millage, exemptions, and the tax-roll history behind them.
A caller sends a parcel and receives its tax position — assessed, exempt and taxable values, the authority levying them, and the roll history year on year.
Two consumers with different needs. Escrow calculation needs the current annual obligation; collateral analysis needs the history, because a long gap between assessed and market value is itself a signal.
## How it works
The dual listing is real: this is the property side, and Tax under Verification is the borrower side — transcripts and returns. They share a name in the source catalogue and nothing else.
The class carrying this data is `tax` in the property model, together with the authority, jurisdiction and exemption classes it points at.
## Dual listing
Tax is filed under two categories. The other listing is Tax under Verification
, and the recorded specifications resolve there — its 3 operations render on that page.
## Operations
### Workflow
`POST` `/products/property-taxes/invocations`
#### Invoke Product Flow
`InvokeSpecificProductFlow`
This endpoint retrieves the Property Taxes for the given property using different partners.
#### Usage
You can send a request in two different ways:
- Using `request_data`: If you provide this parameter, flow invocation would use the data here as input. If you also provide a `transaction_id` in the request body, Response Collection would be created in the related Transaction object. If you don't provide a `transaction_id` we will automatically create a Transaction for you and Response Collection would be created in this new Transaction as well.
- Using `transaction_id` and `request_collection_id`: If you already have a request collection, you can provide its details using these two parameters. Note that in this case Response Collection would be created in the provided Transaction.
Note: You cannot provide `product_flow_name` and `vendor_name` parameters together. When provided together, simply `product_flow_name` is used.
Show the rest
#### Retrieving the Invocation Result
After invocation, endpoint returns an `invocation_id` which you can poll for its status using /products/property-taxes/invocations/{invocation_id} endpoint. Once the invocation is completed, the Response Collection is populated with these search results.
If you would rather receive a callback once the invocation is completed instead of polling it, you can set `callback_url` parameter in the request body.
##### Request
Flow Invocation with Collection IDRequest Example
application/json Copy
```
{
"vendor_name": "ernst",
"transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4",
"request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN"
}
```
application/json Copy
```
{
"vendor_name": "ernst",
"request_data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
}
```
##### Response
201400403404500
application/json Copy Successfully started flow invocation.
```
{
"product_flow_name": "ErnstPropertyTaxes",
"metadata": {},
"request_collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
"invocation_id": "08f0f7bd-0158-4ab8-845c-f94eafa3859c",
"invocation_status": "STARTED",
"transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD"
}
```
application/json Copy Request data failed validation
```
{
"message": "{'data': ['Missing data for required field.']}"
}
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
1
| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | Environment API Key. |
##### Request body`application/json`
6 fields
| Field | Type | Description |
| --- | --- | --- |
| `vendor_name`required | `string` | Vendor name. If not specified default vendor will be used.`ernst` |
| `transaction_id`required | `string` | Transaction ID used for invocation. |
| `request_collection_id`required | `string` | Request Collection ID. |
| `response_collection_id` | `string` | Response Collection ID. The response will be saved into this collection if response_collection_id is provided. If not provided, a new collection will be created for response. |
| `callback_url` | `string (uri)` | Callback URL. |
| `request_data` | `object` | Request Data. If request_collection_id is not provided and request_data is provided, request data will be saved into a new collection and that collection will be used for invocation. |
| `addresses`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_county_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_state_code`required | `object` | — |
| `has_value`required | `string` | — |
| `has_city_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value`required | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value`required | `string` | — |
| `properties`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `with_value`required | `string[]` | — |
| `with_address`required | `string[]` | — |
| `property_valuations`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_property_valuation_amount`required | `object` | — |
| `has_value`required | `number` | — |
##### Response `201``application/json`
7 fields
Successfully started flow invocation.
| Field | Type | Description |
| --- | --- | --- |
| `invocation_id` | `string` | Invocation ID. |
| `invocation_status` | `string` | The status of the invocation.`STARTED` |
| `transaction_id` | `string` | Transaction ID. |
| `product_flow_name` | `string` | Product flow name.`ErnstPropertyTaxes` |
| `metadata` | `object` | The metadata of the invoked product flow. |
| `callback_url` | `string` | Callback URL. |
| `request_data` | `object` | The data for the request collection. |
##### Response `400``application/json`
1 fields
Request data failed validation
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
`GET` `/products/property-taxes/invocations/{invocation_id}`
#### Retrieve Invocation Status
`RetrieveProductFlowInvocationStatus`
Retrieve status of a Product Flow Invocation
Retrieves the status of running Product flow invocation.
##### Response
200400403404500
application/json Copy Successfully returned status of the Product flow Invocation.
```
{
"request_collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
"response_collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
"metadata": {},
"invocation_id": "08f0f7bd-0158-4ab8-845c-f94eafa3859c",
"invocation_status": "RUNNING",
"transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
"product_flow_name": "ErnstPropertyTaxes",
"request_collection": {
"metadata": {
"created_at": "2021-09-14T03:08:00.284090-04:00",
"validation": false
},
"transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
"collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
"data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
},
"response_collection": {
"metadata": {
"created_at": "2021-09-14T03:36:45.193268-04:00",
"validation": false
},
"transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
"collection_id": "01FFHKS6W9J0JDTGTQJB9Y2RWB",
"data": {
"taxes": [
{
"@id": "TX1010000",
"@type": "property_tax",
"with_payment": [
"01FN8GGQ44MPFQPRKX2QW3JZJ7"
],
"has_tax_authority_name": {
"has_value": "HARRIS COUNTY"
},
"has_tax_authority_account_identifier": {
"has_value": "TX1010000"
},
"has_tax_description": {
"has_value": "Tax Bill Installment 1"
}
},
{
"@id": "TX1010339",
"@type": "property_tax",
"with_payment": [
"01FN8GGQ44W42284VRXP5G53RE"
],
"has_tax_authority_name": {
"has_value": "HEATHERLOCH MUD (ASMT OF SW)"
},
"has_tax_authority_account_identifier": {
"has_value": "TX1010339"
},
"has_tax_description": {
"has_value": "Tax Bill Installment 1"
}
}
],
"payments": [
{
"@id": "01FN8GGQ44MPFQPRKX2QW3JZJ7",
"@type": "tax_payment",
"has_next_payment_due_date": {
"has_value": "2022-01-31"
},
"has_payment_amount": {
"has_value": "3880.99"
}
},
{
"@id": "01FN8GGQ44W42284VRXP5G53RE",
"@type": "tax_payment",
"has_next_payment_due_date": {
"has_value": "2021-01-31"
},
"has_payment_amount": {
"has_value": "1063.92"
}
}
]
}
}
}
```
application/json Copy Request data failed validation
```
{
"message": "{'data': ['Missing data for required field.']}"
}
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | Environment API Key. |
| `invocation_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Product flow invocation identifier |
##### Response `200``application/json`
9 fields
Successfully returned status of the Product flow Invocation.
| Field | Type | Description |
| --- | --- | --- |
| `invocation_status`required | `string` | Invocation Status.`ACTION_REQUIRED``COMPLETED``FAILED``RUNNING``STARTED` |
| `transaction_id`required | `string` | Transaction ID used for invocation. |
| `request_collection_id` | `string` | Request Collection ID. |
| `request_collection` | `object` | Collection. |
| `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | Data in Staircase language schema. |
| `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. |
| `response_collection_id` | `string` | Response Collection ID. |
| `response_collection` | `object` | Collection. |
| `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | — |
| `taxes` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `with_payment` | `string[]` | — |
| `has_tax_authority_name` | `object` | — |
| `has_tax_authority_account_identifier` | `object` | — |
| `has_tax_description` | `object` | — |
| `payments` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_next_payment_due_date` | `object` | — |
| `has_payment_amount` | `object` | — |
| `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. |
| `callback_url` | `string` | URL that was specified in flow invocation and will be used to send the callback when flow invocation will be finished. |
| `widget_url` | `string (uri)` | URL of the widget. |
| `metadata` | `object` | Response Collection ID. |
##### Response `400``application/json`
1 fields
Request data failed validation
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
`GET` `/products/property-taxes/request-schema`
#### Retrieve Request Schema
`retrieveRequestSchema`
Retrieve Request Schema retrieves a JSON schema for the request collection that you can provide to the invocation.
If you'd like to retrieve some examples for the request collection, use `return_examples=True` query parameter.
##### Response
200 Schema200 Schema with Examples400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
application/json Copy Request schema (possibly with examples) is successfully returned.
```
{
"schema": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"has_county_name",
"has_state_code",
"has_city_name"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_county_name": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_state_code": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_city_name": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_postal_code": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_address_line_1_text": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"with_value",
"with_address"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"with_value": {
"type": "array",
"items": {
"type": "string"
}
},
"with_address": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"property_valuations": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"has_property_valuation_amount"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_property_valuation_amount": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "number"
}
}
}
}
}
}
},
"required": [
"addresses",
"properties",
"property_valuations"
],
"description": "Request Data. If request_collection_id is not provided and request_data is provided, request data will be saved into a new collection and that collection will be used for invocation."
}
}
```
application/json Copy Request schema (possibly with examples) is successfully returned.
```
{
"schema": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"has_county_name",
"has_state_code",
"has_city_name"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_county_name": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_state_code": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_city_name": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_postal_code": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_address_line_1_text": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"with_value",
"with_address"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"with_value": {
"type": "array",
"items": {
"type": "string"
}
},
"with_address": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"property_valuations": {
"type": "array",
"items": {
"type": "object",
"required": [
"@type",
"@id",
"has_property_valuation_amount"
],
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_property_valuation_amount": {
"type": "object",
"required": [
"has_value"
],
"properties": {
"has_value": {
"type": "number"
}
}
}
}
}
}
},
"required": [
"addresses",
"properties",
"property_valuations"
],
"description": "Request Data. If request_collection_id is not provided and request_data is provided, request data will be saved into a new collection and that collection will be used for invocation."
},
"examples": [
{
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
]
}
```
application/json Copy Error
```
{
"message": "Please provide one of valid return examples values:\ntrue, false"
}
```
text/html Copy Error
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"type": "string",
"description": "Error Message."
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
2
| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | Environment API Key. |
| `return_examples` | `boolean` query | If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false` |
##### Response `200``application/json`
2 fields
Request schema (possibly with examples) is successfully returned.
| Field | Type | Description |
| --- | --- | --- |
| `schema`required | `object` | Schema for the Request Collection |
| `examples` | `object` | Each item in the dictionary corresponds to the name of the example and dictionary content is the sample response. |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error Message. |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
`GET` `/products/property-taxes/response-schema`
#### Retrieve Response Schema
`retrieveResponseSchema`
Retrieve Response Schema returns the JSON schema for the response collection, created by an invocation.
If you would like to retrieve examples along with the schema, you can provide `return_examples=True` query parameter.
##### Response
200 Schema200 Schema with Examples Response400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
application/json Copy Response schema (possibly with examples) is successfully returned.
```
{
"schema": {
"type": "object",
"properties": {
"taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"with_payment": {
"type": "array",
"items": {
"type": "string"
}
},
"has_tax_authority_name": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_tax_authority_account_identifier": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_tax_description": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_next_payment_due_date": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_payment_amount": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
}
}
}
}
```
application/json Copy Response schema (possibly with examples) is successfully returned.
```
{
"schema": {
"type": "object",
"properties": {
"taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"with_payment": {
"type": "array",
"items": {
"type": "string"
}
},
"has_tax_authority_name": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_tax_authority_account_identifier": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_tax_description": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
},
"@id": {
"type": "string"
},
"has_next_payment_due_date": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
},
"has_payment_amount": {
"type": "object",
"properties": {
"has_value": {
"type": "string"
}
}
}
}
}
}
}
},
"examples": [
{
"taxes": [
{
"@id": "TX1010000",
"@type": "property_tax",
"with_payment": [
"01FN8GGQ44MPFQPRKX2QW3JZJ7"
],
"has_tax_authority_name": {
"has_value": "HARRIS COUNTY"
},
"has_tax_authority_account_identifier": {
"has_value": "TX1010000"
},
"has_tax_description": {
"has_value": "Tax Bill Installment 1"
}
},
{
"@id": "TX1010339",
"@type": "property_tax",
"with_payment": [
"01FN8GGQ44W42284VRXP5G53RE"
],
"has_tax_authority_name": {
"has_value": "HEATHERLOCH MUD (ASMT OF SW)"
},
"has_tax_authority_account_identifier": {
"has_value": "TX1010339"
},
"has_tax_description": {
"has_value": "Tax Bill Installment 1"
}
}
],
"payments": [
{
"@id": "01FN8GGQ44MPFQPRKX2QW3JZJ7",
"@type": "tax_payment",
"has_next_payment_due_date": {
"has_value": "2022-01-31"
},
"has_payment_amount": {
"has_value": "3880.99"
}
},
{
"@id": "01FN8GGQ44W42284VRXP5G53RE",
"@type": "tax_payment",
"has_next_payment_due_date": {
"has_value": "2021-01-31"
},
"has_payment_amount": {
"has_value": "1063.92"
}
}
]
}
]
}
```
application/json Copy Error
```
{
"message": "Please provide one of valid return examples values:\ntrue, false"
}
```
text/html Copy Error
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"type": "string",
"description": "Error Message."
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
2
| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | Environment API Key. |
| `return_examples` | `boolean` query | If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false` |
##### Response `200``application/json`
2 fields
Response schema (possibly with examples) is successfully returned.
| Field | Type | Description |
| --- | --- | --- |
| `schema`required | `object` | JSON-Schema as a single object |
| `examples` | `object` | A key-value pair for the examples. Keys are the example names, while values correspond to the example values for the response collections you can retrieve. |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error Message. |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
### Platform
`POST` `/transactions`
#### Create Transaction
`createTransaction`
Create Transaction creates a transaction in Staircase. Transactions in Staircase are containers for all the data related to an instance of a transaction type. They enable you to correlate the output of various products to a single transaction type, where the transaction type depends on your line of business.
Transactions are identified by a unique key called `transaction_id`. As you use different Staircase products to gather the data needed for a specific instance of your transaction type, and receive different sets of output from each product, use the same transaction_id to correlate all the outputs to the same transaction. A `transaction_id`, when used properly, gives you a holistic view of the data related to the transaction you’ve assembled.
To access all collections associated with a given transaction_id, try out /transactions/{transaction_id}/collections
##### Response
201403500
application/json Copy Transaction created successfully
```
{
"transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
"created_at": "03/04/2021, 1:04:05 PM EST"
}
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
1
| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | Environment API Key. |
##### Response `201``application/json`
2 fields
Transaction created successfully
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01F0KHK7DN3H5JZ4QJKMYAM6GB` |
| `created_at` | `string` | Staircase time string.Example `03/03/2021, 8:24:04 AM EST` |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Other responses
`400`
`POST` `/transactions/{transaction_id}/collections`
#### Create Collection
`createCollection`
Create Collection creates a collection of data points required for product invocation. A collection contains a digital representation of the input or output data for the product and is identified by `collection_id`.
The Example below contains a sample collection that you can use to make the product invocation in /products/property-taxes/invocations
##### Request
application/json Copy
```
{
"data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
}
```
##### Response
201400 CreateCollectionError400 text/html403404 CreateCollectionError404 text/html500
application/json Copy Collection created successfully
```
{
"transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
"collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
"metadata": {
"created_at": "2021-09-14T03:08:00.284090-04:00",
"validation": false
},
"data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
}
```
application/json Copy Error
```
{
"message": "Unable to create collection. Please check the collectionchr\ndata"
}
```
text/html Copy Error
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to create collection. Please check the transaction\nID."
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | Environment API Key. |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | Request Data. If request_collection_id is not provided and request_data is provided, request data will be saved into a new collection and that collection will be used for invocation. |
| `addresses`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_county_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_state_code`required | `object` | — |
| `has_value`required | `string` | — |
| `has_city_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value`required | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value`required | `string` | — |
| `properties`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `with_value`required | `string[]` | — |
| `with_address`required | `string[]` | — |
| `property_valuations`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_property_valuation_amount`required | `object` | — |
| `has_value`required | `number` | — |
##### Response `201``application/json`
4 fields
Collection created successfully
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | Data in Staircase language schema. |
| `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message object with more properties. |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Other responses
`405`
`GET` `/transactions/{transaction_id}/collections/{collection_id}`
#### Retrieve Collection
`retrieveCollection`
Retrieve Collection returns the content of a given `collection_id` associated with a `transaction_id`.
##### Response
403404 GetCollectionError404 GetCollectionsError500
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collection. Please check the given ids"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collections of given transaction. Please\ncheck the transaction id"
}
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | Environment API Key. |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Staircase collection_id |
##### Response `200``application/json`
4 fields
Successfully Retrieved Collection
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | — |
| `collection_id`required | `string` | — |
| `metadata`required | `object` | — |
| `created_at`required | `string` | — |
| `validation`required | `boolean` | — |
| `data`required | `object` | — |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Other responses
`400`
`GET` `/transactions/{transaction_id}/collections`
#### Retrieve Transaction Collections
`RetrieveTransactionCollections`
Retrieve Transaction Collections returns the content of a given `collection_id` associated with a specific `transaction_id`.
##### Response
200400403404500
application/json Copy Transaction collection retrieved successfully
```
{
"metadata": {
"created_at": "2021-09-14T03:08:00.284090-04:00",
"validation": false
},
"transaction_id": "01FFHJ2ZVS4P7N4AV5W0993QMD",
"collection_id": "01FFHJ4JCWGHV38SC1NJ8TVNFY",
"data": {}
}
```
text/html Copy Error
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to get collections of given transaction. Please\ncheck the transaction id"
}
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | Environment API Key. |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier |
##### Response `200``application/json`
4 fields
Transaction collection retrieved successfully
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | Data in Staircase language schema. |
| `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message object with more properties. |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
`PUT` `/transactions/{transaction_id}/collections/{collection_id}`
#### Update Collection
`updateCollection`
Update Collection allows you to update the content of a given `collection_id` associated with a `transaction_id`.
##### Request
application/json Copy
```
{
"data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
}
```
##### Response
200400 UpdateCollectionError400 text/html403404 UpdateCollectionError404 text/html500
application/json Copy Collection updated successfully
```
{
"transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
"collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN",
"metadata": {
"created_at": "2021-09-14T03:08:00.284090-04:00",
"validation": false
},
"data": {
"addresses": [
{
"@id": "01FMM41S2R86Q33TC28H9RC197",
"@type": "residential_address",
"has_county_name": {
"has_value": "Kent"
},
"has_state_code": {
"has_value": "TX"
},
"has_city_name": {
"has_value": "Houston"
},
"has_postal_code": {
"has_value": "77069"
},
"has_address_line_1_text": {
"has_value": "5118 Westerham Pl"
}
}
],
"properties": [
{
"@id": "01FMM41S2RE99T8XGQJC2MTE8E",
"@type": "property",
"with_value": [
"01FMM41S2RM5X2RWJJG2NFH91Z"
],
"with_address": [
"01FMM41S2R86Q33TC28H9RC197"
]
}
],
"property_valuations": [
{
"@id": "01FMM41S2RM5X2RWJJG2NFH91Z",
"@type": "property_valuation",
"has_property_valuation_amount": {
"has_value": 374900
}
}
]
}
}
```
application/json Copy Error
```
{
"description": "Error details.",
"message": "Unable to update collection. Please check the collection\ndata"
}
```
text/html Copy Error
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy 403 invalid error
```
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
```
application/json Copy Resource not found
```
{
"message": "Unable to update collection. Please check the given ids"
}
```
text/html Copy Resource not found
```
\r\n400 Bad Request\r\n\r\n400
Bad Request
\r\n\r\n\r\n
```
application/json Copy Internal server error
```
{
"message": "The product has encountered an internal server error. If you\nhave used a transaction_id to call our services, please submit it to\nStaircase support"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | Environment API Key. |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Staircase collection_id |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | Request Data. If request_collection_id is not provided and request_data is provided, request data will be saved into a new collection and that collection will be used for invocation. |
| `addresses`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_county_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_state_code`required | `object` | — |
| `has_value`required | `string` | — |
| `has_city_name`required | `object` | — |
| `has_value`required | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value`required | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value`required | `string` | — |
| `properties`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `with_value`required | `string[]` | — |
| `with_address`required | `string[]` | — |
| `property_valuations`required | `object[]` | — |
| `@type`required | `string` | — |
| `@id`required | `string` | — |
| `has_property_valuation_amount`required | `object` | — |
| `has_value`required | `number` | — |
##### Response `200``application/json`
4 fields
Collection updated successfully
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `object` | Data in Staircase language schema. |
| `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. |
##### Response `400``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message object with more properties. |
##### Response `403``application/json`
2 fields
403 invalid error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
| `url` | `string` | Error additional URL. |
##### Response `404``application/json`
1 fields
Resource not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Message |
##### Response `500``application/json`
1 fields
Internal server error
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Other responses
`405`
### Operations
`POST` `/property-taxes`
#### Create Property taxes
`post-property-taxes`
##### Request
application/json Copy
```
{
"transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"partner_name": "PartnerName"
}
```
##### Response
application/json Copy Property taxes request created successfully.
```
{
"collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
"message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `collection_id`required | `string` | Collection ID |
| `partner_name`required | `string` | — |
##### Response `200``application/json`
2 fields
Property taxes request created successfully.
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | Collection ID |
| `message` | `string` | Message |
`GET` `/property-taxes/elements`
#### Retrieve Elements
`get-property-taxes-elements`
Retrieve Elements provides a list of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Elements needed for request.
| Field | Type | Description |
| --- | --- | --- |
| `elements` | `object` | List of elements |
`POST` `/property-taxes/elements/complete`
#### Validate Collection
`post-property-taxes-collection-complete`
Validate Collection validates that a collection contains all of the elements needed to invoke a partner product.
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `collection`required | `object` | — |
##### Response `400``application/json`
2 fields
Collection is invalid.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message |
| `errors` | `object` | List of elements that are missing |
##### Other responses
`200`
`GET` `/property-taxes/status/{transaction_id}/{collection_id}`
#### Retrieve Status
`get-property-taxes-status`
Retrieve Status checks status of your request. Possible statuses:
- REQUEST_MADE
- REQUEST_ACCEPTED
- WAITING_FOR_RESPONSE
- COMPLETED
##### Response
200400
application/json Copy Statuses include: * REQUEST_MADE * REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
```
{
"status": "COMPLETED"
}
```
application/json Copy Status is unavailable
```
{
"error": "Request for specified transaction_id and collection_id was not found!"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `9u8z7t65-cb71-4f20-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `e4502ed2-8df8-4b8f-84bd-a1097e999a77` | Collection ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Statuses include: * REQUEST_MADE
* REQUEST_ACCEPTED
* WAITING_FOR_RESPONSE
* COMPLETED
| Field | Type | Description |
| --- | --- | --- |
| `status` | `object` | Current execution status |
##### Response `400``application/json`
1 fields
Status is unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message |
`POST` `/property-taxes/transactions`
#### Create Transaction
`post-property-taxes-transaction`
Create Transaction creates a transaction in Staircase. A transaction in Staircase is an acknowledgement that you want to call a Staircase product. It's a container for everything associated with that product invocation, and is correlated with a collection related to the product (e.g. a document). You need to create a new transaction every time you want to connect with a Staircase product. Staircase then associates everything, from a data and API execution standpoint, to that transaction.
##### Response
application/json Copy Transaction successfully created.
```
{
"transaction_id": "a34c40a6-3c02-44f9-a696-cd7388f506d3"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Response `200``application/json`
1 fields
Transaction successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string` | Transaction ID |
`POST` `/property-taxes/transactions/{transaction_id}/collections`
#### Create Collection
`post-property-taxes-collection`
Create Collection creates a collection of elements . The elements within the collection are required.
##### Request
application/json Copy
```
{
"sets": {
"set": [
{
"elements": {
"element": [
{
"property_entry": {
"property_entries": {
"datetime": "2020-08-25",
"description": "Description of property",
"event_type": "TestType"
}
},
"property_class": {
"property_clases": {
"type": "STATEMENT"
},
"name": "Test",
"period_start_date": "2020-07-01",
"period_end_date": "2020-07-31"
},
"content": {
"foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy Collection successfully created.
```
{
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"data": {
"sets": {
"set": [
{
"elements": {
"element": [
{
"property_entry": {
"property_entries": {
"datetime": "2020-08-25",
"description": "Description of property",
"event_type": "TestType"
}
},
"property_class": {
"property_clases": {
"type": "STATEMENT"
},
"name": "Test",
"period_start_date": "2020-07-01",
"period_end_date": "2020-07-31"
},
"content": {
"foreign_object": "7e62ce76-d93d-4f31-92d3-45c2cb8255ea"
}
}
]
}
}
]
}
},
"metadata": {},
"transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully created.
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
`PUT` `/property-taxes/transactions/{transaction_id}/collections/{collection_id}`
#### Update Collection
`put-property-taxes-collection`
Update Collection updates a collection of elements by new elements.
##### Request
application/json Copy
```
{
"sets": {
"set": [
{
"properties": {
"property": [
{
"propety_entry": {
"propety_entries": {
"datetime": "2020-05-05",
"description": "Test Description",
"event_type": "TestType"
}
},
"propety_class": {
"propety_classes": {
"type": "TestType"
},
"name": "TestName",
"period_start_date": "2019-01-01",
"period_end_date": "2019-12-31"
},
"content": {
"foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
}
}
]
}
}
]
}
}
```
##### Response
application/json Copy Collection successfully updated
```
{
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"data": {
"sets": {
"set": [
{
"properties": {
"property": [
{
"property_data": {
"property_class": {
"datetime": "2020-05-05",
"description": "Info",
"event_type": "TestEvent"
}
},
"document_classification": {
"document_classes": {
"type": "TestType"
},
"name": "TestName",
"period_start_date": "2019-01-01",
"period_end_date": "2019-12-31"
},
"content": {
"foreign_object": "7z6t5r4e-d93d-4f31-92d3-45c2cb8255ea"
}
}
]
}
}
]
}
},
"metadata": {},
"transaction_id": "6t5r4wq1-9d74-g17e-99ca-a36b30vdfd35"
}
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `transaction_id` required | `string` path | `3wet53r4-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `collection_id` required | `string` path | `9u8z7t65-cb71-8u74-8e40-7a829b52e91e` | Transaction ID |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API Key |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `data`required | `object` | — |
| `metadata` | `object` | — |
##### Response `200``application/json`
4 fields
Collection successfully updated
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `object` | Transaction ID |
| `collection_id` | `object` | Collection ID |
| `data` | `object` | Data object |
| `metadata` | `object` | Metadata object |
`POST` `/tax`
#### Create Tax
`post-tax`
Create Tax creates views of a borrower's tax returns, including IRS documents 4506T, W-2, 1040, 1065, 1098, 1099, 1120, and 5498.
##### Request
application/json Copy
```
{
"transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"partner_name": "PartnerName"
}
```
##### Response
application/json Copy Tax report request created successfully.
```
{
"collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
"message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `collection_id`required | `string` | Collection ID |
| `partner_name`required | `string` | — |
##### Response `200``application/json`
2 fields
Tax report request created successfully.
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | Collection ID |
| `message` | `string` | Message |
## Errors
`400``403``404``405``500`
## More in Assessment
- Previous product: Property
- Next product: Valuation