Billing Invoice (aka Statements) model

Billing Invoice data dictionary

What is a Billing Invoice object on Groov platform?

The billing invoice object allows you to retrieve the sellers/businesses monthly (normally) statements in a pdf downloadable format. Such statements are available on the sellers commerce/payment partner platform account that is generated by the provider, this has details of the transaction breakdown across card brand/funding methods incl premium and monthly charges as well as will have details of the VAT breakdown based on the VAT setup of the seller.

Data Dictionary


Attribute	Type	Description
object	string	value is "billing_invoice"
Id	string	Unique identifier for the object (as on Groovs db)
partnerSource	string	name of the partner system
ledgerAccountId	string	id of the merchant account ledger entry as setup on Groov platform.
accountId	string	MID or the account reference as maintained on the partner system
InvoiceYear	string	States the year in which the invoice has been generated by the partner source system.
InvoiceMonth	string	States the month in which the invoice has been generated by the partner source system.
InvoicePeriod	string	The period for which the invoice has been generated
amount	string	The value of the invoice for the stated period as charged by the Billing process in the partner source system
currency	hash	Three-letter ISO currency code representing the default currency in which the invoice amount was captured
description	string	A description of the invoice as provided by the partner source system
invoiceReference	string	A reference/number of the invoice as provided by the partner source system
invoiceDocument	string	Provides a link to the invoice document in a pdf format as generated by the partner source system for the associated invoicing period
billingAccount	string	id of the billing account as on partner system, normally its a MID or a billing organisation setup
partnerCreatedDate	timestamp	Date the object was created in the commerce or partner platform
modifiedDate	date	Date the record was last updated in the our system.