Skip to main content
amount_paid
object

Preview: Amount paid while the invoice is partially paid. The amount is in the currency's major unit. The field is omitted after the invoice is fully paid.

reference
string
Example:

"CDEF - 0342/7055 2022"

number
string
Example:

"FAC2022-9567"

ovrsea_shipment_id
string

Four-letter code for orders opened before 2026-12-01 00:00 UTC. Full file reference for orders opened from that instant, including orders opened as quote requests.

Example:

"BB-BATD-5"

type
enum<string>
default:invoice
Available options:
invoice,
credit_note
status
enum<string>
Available options:
available,
due,
in_modification,
litigious,
new,
paid,
partially_paid,
write_off
sent_date
string
Example:

"2021-09-20T10:02:09+01:00"

due_date
string
Example:

"2021-10-11"

Preview: Signed URL for downloading the invoice file. It is valid for three hours, and anyone holding the URL can open it.

Example:

"https://documents.ovrsea.com/invoices/FAC2022-9567.pdf?Expires=1700000000&Signature=..."

lines
object[]
payment_date
string

Preview: Calendar day on which the invoice was marked fully paid. The field is present only after full payment.

Example:

"2021-10-11"

recipient
object

Preview: Company billed by the invoice. The name is the name written on the invoice.

shipment_ids
string[]

Preview: Public shipment references covered by a grouped invoice that you can read. Each value uses the same identifier as a shipment resource.

total_excluding_tax
object

Preview: Invoice total excluding tax. The amount is in the currency major unit.

total_including_tax
object

Preview: Invoice total including tax. The amount is in the currency major unit.

usd_to_eur_rate
number<float>
Example:

0.82