Update a Tax Line

PUT 
/api/v8/partner/documents/:document_id/tax-lines/:tax_line_id

Update a Tax Line

Request

Path Parameters

document_id int64required

The unique identifier of the document.

tax_line_id int64required

The unique identifier of the tax line.

application/json

Body

base object
The base amount of the tax applied.
anyOf
MOD1
number
DetailedPUTFloatField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
name object
The name of the sales tax type.
anyOf
MOD1
string
DetailedShortPUTField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value stringrequired
Possible values: non-empty
The value to update
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
rate object
The tax rate (percentage) applied to the base amount. This value is computable.
anyOf
MOD1
number
DetailedPUTFloatField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
total object
The total amount of tax charged for this particular tax line item. If the document has multiple taxes on it those taxes will be returned in the list inside the taxes field. Note there are a couple of countries in the world that have 3 decimal places after the dot.
anyOf
MOD1
number
DetailedPUTFloatField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
code object
The tax identification code.
anyOf
MOD1
string
DetailedShortPUTField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value stringrequired
Possible values: non-empty
The value to update
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
total_inclusive object
The base rate + tax amount.
anyOf
MOD1
number
DetailedPUTFloatField
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
value numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]

Responses

204

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 150 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

status stringrequired

Possible values: [fail, ok]

error string
message stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string",
  "message": "string",
  "details": [
    {}
  ]
}

Loading...