TaxManagement

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "TaxManagement",
  "id": "http://ingrammicro.com/cb/tax-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "useParentSettings": {
      "path": "tax/useParentSettings",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "request": {
          "kind": "body",
          "type": "TaxConfig",
          "required": true
        }
      }
    }
  },
  "structures": {
    "TaxConfig": {
      "type": "object",
      "properties": {
        "accountId": {
          "type": "integer",
          "required": true
        },
        "taxPlugin": {
          "type": "string",
          "required": true
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
useParentSettings	POST	/tax/useParentSettings		Apply tax parent settings, can be configured only for VERTEX tax plugin

useParentSettings

HTTP Request

POST /aps/2/resources/{aps-id}/tax/useParentSettings

Description

Apply tax parent settings, can be configured only for VERTEX tax plugin

Parameters

PARAMETER	TYPE	DESCRIPTION
request	TaxConfig	Account and tax plugin configuration

Returns

Structures

TaxConfig

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
accountId	Integer	Required
taxPlugin	String	Required

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← TaxCategory

Reporting and Data Export →