Skip to main content
PATCH
Partially update a supplier invoice

Authorizations

Authorization
string
header
required

Workspace API key sent as a bearer token: Authorization: Bearer failfast_.... Create keys in Settings -> Workspace -> API Keys.

Path Parameters

id
string<uuid>
required

A UUID string identifying this invoice.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

custom_fields
unknown
operation_number
integer
default:0
Required range: 0 <= x <= 2147483647
operation_date
string<date-time>
description
string | null
operation_status
enum<string>
  • PR - Provisional
  • CO - Complete
  • ER - Error
Available options:
PR,
CO,
ER
status_description
string | null
prefix
string | null
invoice_number
integer
Required range: 0 <= x <= 2147483647
issue_date
string<date-time>
document_type
enum<string>
  • ADV - Advance
  • INV - Invoice
  • CRN - Credit Note
Available options:
ADV,
INV,
CRN
is_pay_authorized
boolean
discount_percentage
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
discount_value
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
other_discount_value
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
subtotal
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
total
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
vat_value_included
string<decimal>
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
order_number
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
invoice_electronic
boolean
is_directly_created
boolean
operation
string<uuid>
market_exchange_rate
string<uuid> | null
branch_office
string<uuid>
supplier
string<uuid>
supplier_detail
string<uuid>
supplier_type
string<uuid>
account
string<uuid>
cost_center
string<uuid> | null
location
string<uuid>
international_trade_term
string<uuid> | null
commercial_condition
string<uuid>
discount_type
string<uuid> | null
tree_hash
string<uuid> | null

Response

200 - application/json
message
string
required

Human-readable outcome of the request.

error
boolean
required

true when the request failed.

Example:

false

data
object
required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.