Skip to main content
PATCH
Partially Update Contract Invoice

Path Parameters

id
integer
required

Body

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

ordinal
integer
Required range: 0 <= x <= 2147483647
invoice_number
string
Maximum string length: 255
status
enum<string>
  • DRAFT - Draft
  • SCHEDULED - Scheduled
  • OPEN - Open
  • SENT - Sent
  • PAID - Paid
  • VOIDED - Voided
Available options:
DRAFT,
SCHEDULED,
OPEN,
SENT,
PAID,
VOIDED
issue_date
string<date>
due_date
string<date> | null
payment_term
integer | null

Terms behind the due date; None means due on receipt or a manually set date.

bill_to_snapshot
any
currency
string
Maximum string length: 3
total_amount
number<double>
Required range: -10000000000000 < x < 10000000000000

Response

200 - application/json

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

id
integer
required
read-only
contract
integer
required
read-only
contract_name
string
required
read-only
contract_number
string
required
read-only
invoice
integer
required
read-only
journal_entry
integer
required
read-only
journal_entry_number
string
required
read-only
issue_date
string<date>
required
lines
object[]
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
ordinal
integer
Required range: 0 <= x <= 2147483647
invoice_number
string
Maximum string length: 255
status
enum<string>
  • DRAFT - Draft
  • SCHEDULED - Scheduled
  • OPEN - Open
  • SENT - Sent
  • PAID - Paid
  • VOIDED - Voided
Available options:
DRAFT,
SCHEDULED,
OPEN,
SENT,
PAID,
VOIDED
due_date
string<date> | null
payment_term
integer | null

Terms behind the due date; None means due on receipt or a manually set date.

bill_to_snapshot
any
currency
string
Maximum string length: 3
total_amount
number<double>
Required range: -10000000000000 < x < 10000000000000