An invoice contains the financial figures relating to the shipment.
Property | Description | Required | Data Type |
---|---|---|---|
invoice_number | Unique identifier of the invoice | True | String |
currency | The currency to be used in the invoice. Should be ISO 4217 format. I.E EUR, GBP | True | String |
from | Sender of the invoice | False | String |
to | Recipient of the invoice | False | String |
invoice_date | The date of the invoice | False | DateTime |
billing_date | The billing date of the invoice | False | DateTime |
due_date | The date payment is due for the invoice | False | DateTime |
lines | The item breakdown for the invoice | True | List<InvoiceLine> |
gift_options_tax_price | The tax cost for gift options i.e gift wrapping | False | decimal |
gift_options_price | The cost for gift options i.e gift wrapping | False | decimal |
insurance_price | The cost of insurance | False | decimal |
notes | Any notes for the invoice | False | string |
settlement_rate_type | Settlement Rate type (Percentage or Flatrate) | False | int |
settlement_rate | The settlement rate | False | decimal |
settlement_value | The settlement value | False | decimal |
settlement_days | The settlement days | False | int |
shipping_rate_type | Shipping Rate type (Percentage or Flatrate) | False | int |
shipping_rate | The shipping rate | False | decimal |
shipping_value | The shipping value | False | decimal |
discount_rate_type | Discount Rate type (Percentage or Flatrate) | False | int |
discount_rate | The discount rate | False | decimal |
discount_value | The discount value | False | decimal |
tax_rate_type | Tax Rate type (Percentage or Flatrate) | False | int |
tax_rate | The tax rate | False | decimal |
tax_value | The tax value | False | decimal |
net_total_price | Net total costs | True | decimal |
total_price | Total costs | True | decimal |