PUT /purchase/bills/\{id\}

PUT 
/purchase/bills/:id

PUT /purchase/bills/{id}

Request

Path Parameters

id int64required

application/json-patch+json

Body

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

application/json

Body

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

text/json

Body

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

application/*+json

Body

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

Responses

200

OK

text/plain

Schema

Schema

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
amount_due doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

Example (from schema)

{
  "id": 0,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "edited_at": "2024-07-29T15:51:28.071Z",
  "is_locked": true,
  "total_amount": 0,
  "subtotal_amount": 0,
  "amount_paid": 0,
  "amount_due": 0,
  "currency": "string",
  "vendor": {
    "id": 0,
    "business_name": "string",
    "display_name": "string",
    "reg_no": "string",
    "vat_no": "string",
    "tax_no": "string",
    "address": {
      "name": "string",
      "company": "string",
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "region": "string",
      "country": "string"
    },
    "email": "string",
    "preferred_locale": "string",
    "phone": "string"
  },
  "date_issued": "2024-07-29",
  "date_taxable": "2024-07-29",
  "date_due": "2024-07-29",
  "no": "string",
  "description": "string",
  "precision": 0,
  "rate_format": "string",
  "taxes_included": true,
  "tax_fx_rate": 0,
  "tax_deduction_ratio": 0,
  "net_deduction_ratio": 0,
  "type": {
    "id": 0,
    "name": "string",
    "associated_payment_cards": [
      "string"
    ]
  },
  "payment_status": "string",
  "overdue_days": 0,
  "tax_nexus": {
    "id": 0,
    "code": "string",
    "currency": "string",
    "taxes": [
      {
        "index": 0,
        "code": "string",
        "name": "string",
        "currency": "string",
        "rate_type": "string",
        "is_implicit": true,
        "rates": [
          {
            "rate": 0,
            "is_default": true
          }
        ]
      }
    ],
    "jurisdiction": {
      "country": "string",
      "region": "string",
      "subregion": "string",
      "city": "string",
      "postal_code": "string"
    },
    "registration_mode": "string"
  },
  "vendor_doc_no": "string",
  "payment_reference": "string",
  "bank_account_number": "string",
  "copy_from_id": 0,
  "gl_account_id": 0,
  "items": [
    {
      "id": 0,
      "description": "string",
      "qty": 0,
      "rate": 0,
      "amount": 0,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "item": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string",
        "desc_org": "string",
        "desc_leg": "string",
        "desc": "string"
      },
      "unit": {
        "id": 0,
        "unece_code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string",
          "gl_account_id": 0
        }
      ],
      "gl_account_id": 0
    }
  ],
  "taxes": [
    {
      "id": 0,
      "tax_index": 0,
      "tax_rate": 0,
      "tax_amount": 0,
      "tax_amount_leg": 0,
      "tax_base": 0,
      "tax_base_leg": 0,
      "tax_code": "string",
      "tax_name": "string",
      "rate_type": "string"
    }
  ],
  "rsn": "string"
}

application/json

Schema

Schema

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
amount_due doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

Example (from schema)

{
  "id": 0,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "edited_at": "2024-07-29T15:51:28.071Z",
  "is_locked": true,
  "total_amount": 0,
  "subtotal_amount": 0,
  "amount_paid": 0,
  "amount_due": 0,
  "currency": "string",
  "vendor": {
    "id": 0,
    "business_name": "string",
    "display_name": "string",
    "reg_no": "string",
    "vat_no": "string",
    "tax_no": "string",
    "address": {
      "name": "string",
      "company": "string",
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "region": "string",
      "country": "string"
    },
    "email": "string",
    "preferred_locale": "string",
    "phone": "string"
  },
  "date_issued": "2024-07-29",
  "date_taxable": "2024-07-29",
  "date_due": "2024-07-29",
  "no": "string",
  "description": "string",
  "precision": 0,
  "rate_format": "string",
  "taxes_included": true,
  "tax_fx_rate": 0,
  "tax_deduction_ratio": 0,
  "net_deduction_ratio": 0,
  "type": {
    "id": 0,
    "name": "string",
    "associated_payment_cards": [
      "string"
    ]
  },
  "payment_status": "string",
  "overdue_days": 0,
  "tax_nexus": {
    "id": 0,
    "code": "string",
    "currency": "string",
    "taxes": [
      {
        "index": 0,
        "code": "string",
        "name": "string",
        "currency": "string",
        "rate_type": "string",
        "is_implicit": true,
        "rates": [
          {
            "rate": 0,
            "is_default": true
          }
        ]
      }
    ],
    "jurisdiction": {
      "country": "string",
      "region": "string",
      "subregion": "string",
      "city": "string",
      "postal_code": "string"
    },
    "registration_mode": "string"
  },
  "vendor_doc_no": "string",
  "payment_reference": "string",
  "bank_account_number": "string",
  "copy_from_id": 0,
  "gl_account_id": 0,
  "items": [
    {
      "id": 0,
      "description": "string",
      "qty": 0,
      "rate": 0,
      "amount": 0,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "item": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string",
        "desc_org": "string",
        "desc_leg": "string",
        "desc": "string"
      },
      "unit": {
        "id": 0,
        "unece_code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string",
          "gl_account_id": 0
        }
      ],
      "gl_account_id": 0
    }
  ],
  "taxes": [
    {
      "id": 0,
      "tax_index": 0,
      "tax_rate": 0,
      "tax_amount": 0,
      "tax_amount_leg": 0,
      "tax_base": 0,
      "tax_base_leg": 0,
      "tax_code": "string",
      "tax_name": "string",
      "rate_type": "string"
    }
  ],
  "rsn": "string"
}

text/json

Schema

Schema

id int64nullable
uid uuidnullable
created_at date-timenullable
edited_at date-timenullable
is_locked boolean
total_amount doublenullable
subtotal_amount doublenullable
amount_paid doublenullable
amount_due doublenullable
currency stringnullable

vendor

object

id int64nullable

business_name stringnullable

display_name stringnullable

reg_no stringnullable

vat_no stringnullable

tax_no stringnullable

address

object

name stringnullable

company stringnullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

region stringnullable

country stringnullable

Possible values: <= 2 characters

email stringnullable

preferred_locale stringnullable

phone stringnullable
date_issued datenullable
date_taxable datenullable
date_due datenullable
no stringnullable
description stringnullable
precision int32nullable
rate_format stringnullable
taxes_included boolean
tax_fx_rate doublenullable
tax_deduction_ratio doublenullable
net_deduction_ratio doublenullable

type

object

id int32nullable

name stringnullable

associated_payment_cards string[]nullable
payment_status stringnullable
overdue_days int32nullable

tax_nexus

object

id int32nullable

code stringnullable

currency stringnullable

taxes

object[]

nullable

Array [

index int64nullable

code stringnullable

name stringnullable

currency stringnullable

rate_type stringnullable

is_implicit boolean

rates

object[]

nullable

Array [

rate double

is_default boolean

]

]

jurisdiction

object

country stringnullable

region stringnullable

subregion stringnullable

city stringnullable

postal_code stringnullable

registration_mode stringnullable
vendor_doc_no stringnullable
payment_reference stringnullable
bank_account_number stringnullable
copy_from_id int64nullable
gl_account_id int64nullable

items

object[]

nullable

Array [

id int64nullable

description stringnullable

qty double

rate doublenullable

amount doublenullable

tax_deduction_ratio doublenullable

net_deduction_ratio doublenullable

item

object

id int64

code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

desc_org stringnullable

desc_leg stringnullable

desc stringnullable

unit

object

id int32nullable

unece_code stringnullable

name_org stringnullable

name_leg stringnullable

name stringnullable

taxes

object[]

nullable

Array [

id int64nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_index int32nullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

gl_account_id int64nullable

]

gl_account_id int64nullable

]

taxes

object[]

nullable

Array [

id int64nullable

tax_index int32nullable

tax_rate doublenullable

tax_amount doublenullable

tax_amount_leg doublenullable

tax_base doublenullable

tax_base_leg doublenullable

tax_code stringnullable

tax_name stringnullable

rate_type stringnullable

]

rsn stringnullable

Example (from schema)

{
  "id": 0,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "edited_at": "2024-07-29T15:51:28.071Z",
  "is_locked": true,
  "total_amount": 0,
  "subtotal_amount": 0,
  "amount_paid": 0,
  "amount_due": 0,
  "currency": "string",
  "vendor": {
    "id": 0,
    "business_name": "string",
    "display_name": "string",
    "reg_no": "string",
    "vat_no": "string",
    "tax_no": "string",
    "address": {
      "name": "string",
      "company": "string",
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "region": "string",
      "country": "string"
    },
    "email": "string",
    "preferred_locale": "string",
    "phone": "string"
  },
  "date_issued": "2024-07-29",
  "date_taxable": "2024-07-29",
  "date_due": "2024-07-29",
  "no": "string",
  "description": "string",
  "precision": 0,
  "rate_format": "string",
  "taxes_included": true,
  "tax_fx_rate": 0,
  "tax_deduction_ratio": 0,
  "net_deduction_ratio": 0,
  "type": {
    "id": 0,
    "name": "string",
    "associated_payment_cards": [
      "string"
    ]
  },
  "payment_status": "string",
  "overdue_days": 0,
  "tax_nexus": {
    "id": 0,
    "code": "string",
    "currency": "string",
    "taxes": [
      {
        "index": 0,
        "code": "string",
        "name": "string",
        "currency": "string",
        "rate_type": "string",
        "is_implicit": true,
        "rates": [
          {
            "rate": 0,
            "is_default": true
          }
        ]
      }
    ],
    "jurisdiction": {
      "country": "string",
      "region": "string",
      "subregion": "string",
      "city": "string",
      "postal_code": "string"
    },
    "registration_mode": "string"
  },
  "vendor_doc_no": "string",
  "payment_reference": "string",
  "bank_account_number": "string",
  "copy_from_id": 0,
  "gl_account_id": 0,
  "items": [
    {
      "id": 0,
      "description": "string",
      "qty": 0,
      "rate": 0,
      "amount": 0,
      "tax_deduction_ratio": 0,
      "net_deduction_ratio": 0,
      "item": {
        "id": 0,
        "code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string",
        "desc_org": "string",
        "desc_leg": "string",
        "desc": "string"
      },
      "unit": {
        "id": 0,
        "unece_code": "string",
        "name_org": "string",
        "name_leg": "string",
        "name": "string"
      },
      "taxes": [
        {
          "id": 0,
          "tax_rate": 0,
          "tax_amount": 0,
          "tax_amount_leg": 0,
          "tax_base": 0,
          "tax_base_leg": 0,
          "tax_index": 0,
          "tax_code": "string",
          "tax_name": "string",
          "rate_type": "string",
          "gl_account_id": 0
        }
      ],
      "gl_account_id": 0
    }
  ],
  "taxes": [
    {
      "id": 0,
      "tax_index": 0,
      "tax_rate": 0,
      "tax_amount": 0,
      "tax_amount_leg": 0,
      "tax_base": 0,
      "tax_base_leg": 0,
      "tax_code": "string",
      "tax_name": "string",
      "rate_type": "string"
    }
  ],
  "rsn": "string"
}

Loading...