Invoices represent the core financial documents submitted by suppliers to initiate the invoice financing process. An invoice should include essential information such as the invoice number, the total amount owed by the buyer, the due date for payment, the currency, and a reference to the supplier and buyer company identifier.

The invoice object

AttributeTypeDescription
idstringUnique identifier for the object
supplierstringID of the company created using our Companies API endpoint that represents the supplier.
buyerstringID of the company created using our Companies API endpoint that represents the buyer.
invoice_numberstringAn arbitrary string that references the readable invoice number presented on the invoice document for the buyer’s reference
client_reference_idstringA unique string to reference the invoice in your database. This can be your internal system’s database invoice id that can be used to reconcile the invoice with your internal systems.
invoice_documenthashInvoice document created upfront. Refer to create a document
amountnumberTotal amount of invoice in decimal format (i.e. 123.53)
currencystringThree-letter ISO 4217 currency code, in lowercase. Only usd, gbp or eur are accepted at this moment.
type_of_goodsstringType of gooods in the invoice, can be commodities, perishables and other. Refer to Types of goods below.
due_datedateDue date of invoice payment
financinghashContains information related to the financing of the invoice. This information will be available when an invoice has completed a financing session.
statusstringThe status of the financing application for this invoice. Can only be one of newadditional_info_requireddeclined, requesting_signaturesapproved, financed or repaid. Refer to Invoice Statuses below.

Invoice statuses

StatusDescription
draftInvoice is created but not submitted yet
newNewly submitted invoice
additional_info_requiredAdditional documents or information are requested for the invoice
declinedInvoice has been declined
requesting_signaturesDocuments were sent to buyer and supplier for signing
approvedInvoice has been approved and ready for financing
financedInvoice is financed
overdueBuyer has not repaid the invoice in time
repaidInvoice has been repaid by the buyer

Types of goods

Type of goodsDescription
CommoditiesRaw materials or primary agricultural products that are homogenous, interchangeable, and fungible. This means the same commodity type possesses uniform quality regardless of who produced it. Commodities can be broadly grouped into soft and hard commodities. Soft commodities are agricultural products grown and directly consumed or used as raw materials for producing goods. Soft commodities include grains, livestock, oilseeds, and other softs. Hard Commodities are extracted and not grown from the earth; hence, they tend to be non-renewable. They involved energy commodities, metals, and minerals.
PerishablesTypically food items, have a limited shelf life and deteriorate relatively quickly if not properly stored or consumed. These products are highly sensitive to temperature, humidity, and time. Categories of perishables are fresh food items, frozen food items, pharmaceuticals, plants and biological materials. They share similar attributes, such as having a short shelf life, will spoil if not stored and shipped at the right temperature and moisture levels and tend to require special shipping considerations. Examples of perishable foods include fresh fruits and vegetables, meat, fish, and dairy products.
OtherOther types of goods

Example JSON object

{
  "id": "inv_ZYfeeV3qxdmYoG",
  "object": "invoice",
  "supplier": "company_ZYfeeV3qxdmYoG",
  "buyer": "company_OEypr6qrdlPoD",
  "invoice_number": "INV-18293",
  "client_reference_id": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 88000,
  "currency": "usd",
  "type_of_goods": ["perishables", "other"],
  "due_date": "2023-12-22",
  "invoice_document": {
    "id": "doc_POfeeV3qxdmYeY",
    "object": "document",
    "name": "INVOICE-18293.pdf",
    "purpose": "invoice",
    "file_format": "pdf",
    "created": "2023-08-22T15:31:40Z"
  },
  "created": "2023-08-22T15:31:40Z",
  "financing": {
    "first_payment": 79200,
    "second_payment": null,
    "discount": null,
    "volume_adjument_fees": null,
    "insurance_charges": null,
    "late_payment_fees": null,
    "sessions": {
      "object": "list",
      "data": [
        {
          "id": "ifs_FGHE9182938as09s00bbw",
          "object": "invoice.financing.session",
          "status": "completed"
        }
      ]
    }
  }
  "status": "draft"
}