TRtrykintsugi
Nexus

Get nexus for org

Changed on

Get a list of all nexuses for the organization.

get/v1/nexus

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/nexus
  • Auth
    API key in header X-API-KEY

Query parameters

without_paginationboolean

Return all results without pagination

disregard_viewstring nullable

Filter nexuses by disregard view: 'exposed' or 'disregarded'

search_querystring nullable

Search nexuses by state code or state name

status__instring nullable
state_codestring nullable
state_code__instring nullable
country_code__instring nullable
tax_type__instring nullable
order_bystring nullable
collected_tax_nexus_metboolean nullable
pageinteger
sizeinteger

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successful Response

OR

Changes

  • 2c90b14ca671Revision changes
    • warning

      added the new SMALL_PARCEL_VAT enum value to the /// response property for the response status

    • warning

      added the new SMALL_PARCEL_VAT enum value to the // response property for the response status

  • 5aac489fbe23Revision changes
    • breaking

      response property anyOf[subschema #1: Page[NexusResponse]]/items/items/created_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: Page[NexusResponse]]/items/items/earliest_collected_date list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: Page[NexusResponse]]/items/items/updated_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/items/created_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/items/earliest_collected_date list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/items/updated_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the //// response's property format changed from date-time to no format for status

    • breaking

      the //// response's property format changed from date-time to no format for status

    • breaking

      the //// response's property format changed from date-time to no format for status

    • breaking

      the //// response's property format changed from date-time to no format for status

    • breaking

      the //// response's property format changed from date-time to no format for status

    • breaking

      the /// response's property format changed from date-time to no format for status

    • breaking

      the /// response's property format changed from date-time to no format for status

    • breaking

      the /// response's property format changed from date-time to no format for status

    • breaking

      the /// response's property format changed from date-time to no format for status

    • breaking

      the /// response's property format changed from date-time to no format for status

    • info

      the response's property default value 2018-01-01T00:00:00 was removed for the status

    • info

      the response's property default value 2018-01-01T00:00:00 was removed for the status