Skip to main content

Returns a list of document Tax Lines

GET 

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

Returns a list of document Tax Lines

Request

Path Parameters

    document_id int64required

    The unique identifier of the document.

Responses

A list of document Tax Lines

Schema
  • Array [
  • order integerrequired

    The arrangement of tax lines in relation to each other.

    name DetailedFieldrequired

    The name of the sales tax type.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    rate EnrichedDetailedFloatFieldrequired

    The tax rate (percentage) applied to the base amount.

    enriched_value (boolean | null)

    Whether the value is enriched.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total DetailedFloatFieldrequired

    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.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    base DetailedFloatFieldrequired

    The base amount of the tax applied.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    code DetailedField

    The tax identification code.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    total_inclusive DetailedFloatField

    The base rate + tax amount.

    score (number | null)

    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.

    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.

    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

    number

  • ]
  • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
  • ]
Loading...