openapi: 3.2.0
info:
  title: Avalara AvaTax User Defined Fields API
  description: Welcome to the AvaTax API Postman Collection!
  version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: UserDefinedFields
paths:
  /api/v2/companies/{companyId}/userdefinedfields/{id}:
    delete:
      tags:
      - UserDefinedFields
      summary: Avalara DeleteUserDefinedField
      description: 'Marks the existing user defined field for a company as deleted.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.

        * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
      parameters:
      - name: X-Avalara-Client
        in: header
        schema:
          type: string
        description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
        example: AvaTax Postman Collection
      - name: companyId
        in: path
        schema:
          type: string
        required: true
      - name: id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteApiV2CompaniesByCompanyIdUserdefinedfieldsById
      x-operation-id-source: derived
  /api/v2/companies/{companyId}/userdefinedfields:
    get:
      tags:
      - UserDefinedFields
      summary: Avalara ListUserDefinedFieldsByCompanyId
      description: '### Security Policies


        * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.

        * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
      parameters:
      - name: X-Avalara-Client
        in: header
        schema:
          type: string
        description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
        example: AvaTax Postman Collection
      - name: companyId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: getApiV2CompaniesByCompanyIdUserdefinedfields
      x-operation-id-source: derived
    post:
      tags:
      - UserDefinedFields
      summary: Avalara UpdateUserDefinedField
      description: 'Updates a User Defined Field for a company.


        ### Security Policies


        * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.

        * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                id: 1
                companyId: 12345
                name: UDF1
                friendlyName: General Ledger Account Number
                dataType: String
                userDefinedFieldType: Document
                createdUserId: 123
                createdDate: '2023-08-13T00:00:00+00:00'
                modifiedUserId: 12
                modifiedDate: '2023-08-13T00:00:00+00:00'
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: X-Avalara-Client
        in: header
        schema:
          type: string
        description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
        example: AvaTax Postman Collection
      - name: companyId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postApiV2CompaniesByCompanyIdUserdefinedfields
      x-operation-id-source: derived
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic