Invoice

{
  "reference": "CDEF - 0342/7055 2022",
  "number": "FAC2022-9567",
  "lyseo_shipment_id": "CDEF",
  "type": "invoice",
  "status": "available",
  "sent_date": "2021-09-20T10:02:09+01:00",
  "due_date": "2021-10-11",
  "lines": [
    {
      "category": "arrival_customs",
      "description": "IMO Surcharge",
      "price": {
        "amount": 150357.99,
        "currency": "USD"
      },
      "quantity": {
        "value": 350.25,
        "unit": "tc"
      },
      "unit_rate": {
        "amount": 150357.99,
        "currency": "USD"
      },
      "vatRate": 20
    }
  ],
  "usd_to_eur_rate": 0.82
}

reference

string

Example:

"CDEF - 0342/7055 2022"

number

string

Example:

"FAC2022-9567"

lyseo_shipment_id

string

Example:

"CDEF"

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"

lines

object[]

Show child attributes

usd_to_eur_rate

number<float>

Example:

0.82

Document Load

Getting Started

Endpoints

Data Models

Getting Started

Endpoints

Data Models

Documentation Index