openapi: 3.1.0 info: title: Commerce Layer addresses taxjar_accounts API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: taxjar_accounts description: resource type paths: /taxjar_accounts: get: operationId: GET/taxjar_accounts summary: List all taxjar accounts description: List all taxjar accounts tags: - taxjar_accounts responses: '200': description: A list of taxjar account objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountResponseList' post: operationId: POST/taxjar_accounts summary: Create a taxjar account description: Create a taxjar account tags: - taxjar_accounts requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountCreate' responses: '201': description: The created taxjar account object content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountResponse' /taxjar_accounts/{taxjarAccountId}: get: operationId: GET/taxjar_accounts/taxjarAccountId summary: Retrieve a taxjar account description: Retrieve a taxjar account tags: - taxjar_accounts parameters: - name: taxjarAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The taxjar account object content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountResponse' patch: operationId: PATCH/taxjar_accounts/taxjarAccountId summary: Update a taxjar account description: Update a taxjar account tags: - taxjar_accounts parameters: - name: taxjarAccountId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountUpdate' responses: '200': description: The updated taxjar account object content: application/vnd.api+json: schema: $ref: '#/components/schemas/taxjarAccountResponse' delete: operationId: DELETE/taxjar_accounts/taxjarAccountId summary: Delete a taxjar account description: Delete a taxjar account tags: - taxjar_accounts parameters: - name: taxjarAccountId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content components: schemas: taxjarAccountResponse: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN type: type: string description: The resource's type enum: - taxjar_accounts links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/taxjarAccount/properties/data/properties/attributes' relationships: type: object properties: markets: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: The resource ID attachments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: The resource ID events: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: The resource ID event_stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: The resource ID tax_categories: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: The resource ID taxjarAccountResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/taxjarAccountResponse/properties/data' taxjarAccountCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - taxjar_accounts attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar api_key: type: string description: The TaxJar account API key. example: TAXJAR_API_KEY required: - name - api_key relationships: type: object properties: tax_categories: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN taxjarAccount: properties: data: properties: attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true taxjarAccountUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - taxjar_accounts id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true api_key: type: string description: The TaxJar account API key. example: TAXJAR_API_KEY relationships: type: object properties: tax_categories: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT