Returns document tax-line.
GET/api/v8/partner/documents/:document_id/tax-lines/:tax_line_id
Returns document tax-line.
Request
Path Parameters
The unique identifier of the document.
The unique identifier of the tax line.
Responses
- 200
- 400
- 404
- 429
- 499
- 503
- default
A document tax-line.
- application/json
- Schema
- Example (from schema)
Schema
- TaxLineResponse
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
The arrangement of tax lines in relation to each other.
name object
The name of the sales tax type.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
rate object
The tax rate (percentage) applied to the base amount. This value is computable.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
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.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
base object
The base amount of the tax applied.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
code object
The tax identification code.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
Possible values: non-empty
The extracted value.
total_inclusive object
The base rate + tax amount.
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.
number
integer
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.
Possible values: <= 1
The score which shows how confident the model in recognizing value
symbols. See confidence scores explained for more information.
Possible values: <= 1
The score shows how confident the model is that the predicted value
belongs to the field. See confidence scores explained for more information.
Possible values: [0
, 90
, 180
, 270
]
The angle of rotation of the document in degrees.
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- MALFORMED_PARAMETERS
Default value: fail
Default value: Malformed parameters
Default value: [object Object]
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [fail
, ok
]
{
"status": "fail",
"error": "string",
"message": "string",
"details": [
{}
]
}