Skip to main content
PATCH
Partially Update Contract Invoice

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

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.

contract
integer
invoice_number
string
Maximum string length: 255
status
enum<string>
  • SCHEDULED - Scheduled
  • ISSUED - Issued
  • PAID - Paid
  • VOIDED - Voided
Available options:
SCHEDULED,
ISSUED,
PAID,
VOIDED
issue_date
string<date>
due_date
string<date> | null
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
contract_name
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
invoice_number
string
Maximum string length: 255
status
enum<string>
  • SCHEDULED - Scheduled
  • ISSUED - Issued
  • PAID - Paid
  • VOIDED - Voided
Available options:
SCHEDULED,
ISSUED,
PAID,
VOIDED
due_date
string<date> | null
bill_to_snapshot
any
currency
string
Maximum string length: 3
total_amount
number<double>
Required range: -10000000000000 < x < 10000000000000