Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Tax identifiers

Returns a list of tax identifiers

Get all tax identifiers.

get/tax-identifiers

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • eq—return values where the createdTime field equals to this timestamp
  • gt—return values where the createdTime field is after this timestamp
  • gte—return values where the createdTime field is after or equal to this timestamp
  • lt—return values where the createdTime field is before this timestamp
  • lte—return values where the createdTime field is before or equal to this timestamp
updatedTimeobject

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • eq—return values where the updatedTime field equals this timestamp
  • gt—return values where the updatedTime field is after this timestamp
  • gte—return values where the updatedTime field is after or equal to this timestamp
  • lt—return values where the updatedTime field is before this timestamp
  • lte—return values where the updatedTime field is before or equal to this timestamp
endingBeforestring

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstring

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]

Only return objects with these IDs.

customerIdstring

Only return tax identifiers for this customer.

typestring

Only return tax identifiers of this type.

valuestring

Only return tax identifiers with this value.

statestring

Only return tax identifiers in this state.

pendingstring date-time

A filter on the list based on the tax identifier stateTransitions pending field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions pending field is after this timestamp
  • gte - return values where the stateTransitions pending field is after or equal to this timestamp
  • lt - return values where the stateTransitions pending field is before this timestamp
  • lte - return values where the stateTransitions pending field is before or equal to this timestamp
verifiedstring date-time

A filter on the list based on the tax identifier stateTransitions verified field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions verified field is after this timestamp
  • gte - return values where the stateTransitions verified field is after or equal to this timestamp
  • lt - return values where the stateTransitions verified field is before this timestamp
  • lte - return values where the stateTransitions verified field is before or equal to this timestamp
not_validstring date-time

A filter on the list based on the tax identifier stateTransitions not_valid field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions not_valid field is after this timestamp
  • gte - return values where the stateTransitions not_valid field is after or equal to this timestamp
  • lt - return values where the stateTransitions not_valid field is before this timestamp
  • lte - return values where the stateTransitions not_valid field is before or equal to this timestamp

Response

200 OK

hasMoreboolean

Indicates whether or not there are more elements available after this set. If false this set represents the end of the list.

Example response

{
  "hasMore": true,
  "data": [
    {
      "id": "5774321009",
      "createdTime": "2018-04-25T20:36:00Z",
      "customerId": "5774321009",
      "type": "de",
      "value": "DE123456789",
      "state": "pending",
      "stateTransitions": {
        "pending": "2018-04-25T20:36:00Z",
        "verified": "2018-04-25T20:36:00Z",
        "not_valid": "2018-04-25T20:36:00Z"
      },
      "verifiedName": ".",
      "verifiedAddress": ".",
      "updatedTime": "2018-04-25T20:36:00Z",
      "applicability": [
        {
          "country": "FR",
          "entity": "DR_Ireland-Entity",
          "customerType": "business"
        }
      ]
    }
  ]
}