Overview

Invoice is a type of financial records representing the billing sent from merchant to customer. It acts primarily as a collection of other financial records, such as line items, taxes, discounts and credits. Invoice is also referred to as "order".

Create an Invoice

The following fields are required :

• objectType: type of financial record. For Invoice, the value is "invoice".
• id: unique identifier of this record. This is external id received by Leapfin.
• totalAmount: total amount of invoice including tax and discount.
• subtotalAmount: total amount of invoice excluding tax and discount.
• currencyCode: 3-digit ISO code of totalAmount and subtotalAmount fields, e.g. “USD”, "GBP", etc. This is the primary currency of this record
• status: current status of this invoice. Acceptable values are:
  • "drafted": the invoice is created but has not been sent to customers
  • "open": the invoice is issued to customers for payment
  • "paid": the invoice is paid by customers
  • "uncollectible": the invoice is issued but never paid successfully. Payment is not longer expected to be received.
  • "voided": the invoice is canceled after issued to customers
• date: the date-time of when this invoice is created in billing system.

The following fields are optional but are commonly need for creating journal entries:

• issueDate: the date-time when this invoice is issued. If not issued yet, the value is null. In most cases this will be the same as date. However, if invoices can be in a 'drafted' state, then this date can be different.
• uncollectibleDate: the date-time when the payment for this invoice becomes uncollectible. If invoice has not become uncollectible or has been paid, then the value is null. Typically used for dunning/bad debt rule scenarios.
• paidDate: the date-time when this invoice is paid. Typically used for invoice to payment matching.
• dueDate: the date-time when the payment for this invoice is due.
• exchangeRates: a list of exchange rates used to calculate currency conversions
• • currencyCode: 3-digit ISO code, e.g. “USD”, "GBP", etc. This is the target currency of this record
  • rate: conversion rate from primary currency to target currency. i.e. amount in primary currency * rate = converted amount in target currency.
• links: directional relationships pointing from this record to other financial records. While Invoice often expects many other financial records (e.g. Line Item, Tax, etc.) pointing to it, the record usually has no links pointing to other records.
  • objectType: type of the target financial record
  • id: unique identifier of the target financial record
• customFields: additional fields (i.e. key-value pairs) related to this record

Sample Data

{
    "objectType": "invoice",
    "id": "invoice_001",
    "totalAmount": 1090.19,
    "subtotalAmount": 1000.00,
    "currencyCode": "USD",
    "status": "open",
    "date": "2021-01-16T19:20:30",
    "issueDate": "2021-01-16T19:25:10",
    "uncollectibleDate": null,
    "paidDate": null,
    "dueDate": "2021-02-16T00:00:00",
    "exchangeRates": [
      {
        "currencyCode": "EUR",
        "rate": 0.84
      },
      {
        "currencyCode": "GBP",
        "rate": 0.73
      }
    ],
    "links": [],
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
}

Query an Invoice

Invoice records are stored in VW_FT_INVOICE table. It can be accessed via Snowflake Data Sharing and Access.