Update invoice

PATCH

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/invoices/{invoice_id}

Update invoice (DRAFT, SUBMITTED, or VALIDATED before dispatch starts). Updating a VALIDATED invoice auto-demotes it to SUBMITTED and requires re-validation.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Path Parameters

invoice_id

required

Invoice Id

string format: uuid

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Request Body ^required

InvoiceUpdate

Update invoice schema (DRAFT/SUBMITTED or VALIDATED before dispatch starts).

object

irn

Any of:

string

string

<= 200 characters

null

null

invoice_number

Any of:

string

string

<= 200 characters

null

null

invoice_number_policy_id

Any of:

string

string format: uuid

null

null

invoice_type_code

Any of:

string

string

<= 10 characters

null

null

invoice_kind

Any of:

string

string

/^(b2b|b2c|b2g)$/

null

null

issue_date

Any of:

string

string format: date

null

null

issue_time

Any of:

string

string

<= 20 characters

null

null

due_date

Any of:

string

string format: date

null

null

tax_point_date

Any of:

string

string format: date

null

null

tax_currency_code

Any of:

string

string

<= 3 characters

null

null

note

Any of:

string

string

null

null

order_reference

Any of:

string

string

<= 200 characters

null

null

buyer_reference

Any of:

string

string

<= 200 characters

null

null

contract_reference

Any of:

string

string

<= 200 characters

null

null

accounting_cost

Any of:

string

string

<= 100 characters

null

null

external_invoice_number

Any of:

string

string

<= 200 characters

null

null

invoice_period_start

Any of:

string

string format: date

null

null

invoice_period_end

Any of:

string

string format: date

null

null

actual_delivery_date

Any of:

string

string format: date

null

null

payment_terms_note

Any of:

string

string

<= 2000 characters

null

null

customer_id

Any of:

string

string format: uuid

null

null

lines

Any of:

Array<object>

Array<object>

>= 1 items

InvoiceLineBase

Base invoice line schema.

object

line_number

required

Line Number

integer

>= 1

item_name

required

Item Name

string

<= 500 characters

item_description

Any of:

string

string

null

null

sellers_item_id

Any of:

string

string

<= 200 characters

null

null

buyers_item_id

Any of:

string

string

<= 200 characters

null

null

item_type

Any of:

string

string

/^(good|service)$/

null

null

hsn_code

Any of:

string

string

<= 100 characters

null

null

product_category

Any of:

string

string

<= 255 characters

null

null

isic_code

Any of:

integer

integer

null

null

service_category

Any of:

string

string

<= 255 characters

null

null

discount_rate

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

discount_amount

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

fee_rate

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

fee_amount

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

invoiced_quantity

required

Any of:

number

number

> 0

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

unit_code

Unit Code

string

default: C62 <= 10 characters

base_quantity

Any of:

number

number

> 0

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

price_amount

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

tax_category_code

Any of:

string

string

<= 64 characters

null

null

tax_rate

Any of:

number

number

<= 100

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

note

Any of:

string

string

null

null

null

null

document_references

Any of:

Array<object>

Array<object>

DocumentReferenceCreate

Create document reference schema.

object

reference_type

required

Reference Type

string

<= 30 characters /^(billing|dispatch|receipt|originator|contract|additional)$/

document_id

required

Document Id

string

>= 1 characters <= 200 characters

issue_date

Any of:

string

string format: date

null

null

null

null

party_roles

Any of:

Array<object>

Array<object>

InvoicePartyRoleCreate

Create additional party role schema.

object

role

required

Role

string

<= 30 characters /^(payee|bill|ship|tax_representative)$/

party_name

required

Party Name

string

>= 1 characters <= 500 characters

tin

Any of:

string

string

<= 100 characters

null

null

email

Any of:

string

string

<= 255 characters

null

null

phone

Any of:

string

string

<= 30 characters

null

null

street_name

Any of:

string

string

<= 500 characters

null

null

city_name

Any of:

string

string

<= 255 characters

null

null

postal_zone

Any of:

string

string

<= 50 characters

null

null

state

Any of:

string

string

<= 20 characters

null

null

country_code

Any of:

string

string

<= 2 characters

null

null

null

null

credit_reason_code

Any of:

string

string

<= 32 characters

null

null

credit_reason_text

Any of:

string

string

null

null

referenced_invoice_id

Any of:

string

string format: uuid

null

null

Examples

Request payload example

{
  "irn": "string",
  "invoice_number": "string",
  "invoice_number_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invoice_type_code": "string"
}

Responses

200

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}