Virtual Data Resource Templates

Last Modified on 11/17/2021 4:16 am MST

These Virtual Data Resource templates are available in the Resource Template catalog. This list will be updated as new Virtual Data Resource templates are added; keep checking this space for new resources. Finance Templates are as follows:

Customer

A customer is an individual or business who purchases the goods or services.

Field	Type	Description
externalId	string	Friendly reference of the customer/reference of customer from an external system
id	string	Identifier for the customer, unique to the company in the accounting platform.
name	string	Name of the customer as recorded in the accounting system, typically the company name.
active	boolean	Current state of the customer
currency	string	Currency the customer transacts in
creditLimit	number	Current credit limit of the customer.
description	string	Any additional information about the customer
webSite	string	Web address of the customer.
totalOutstandingAmount	number	Amount paid from the customer across all transactions.
totalPaidAmount	number	Amount paid by the customer across all transactions.
account	string	The account linked to the customer in the accounting system.
createdDate	date	Date the record was created in the accounting system.
endDate	date	Date the customer stopped transacting as per accounting system.
language	string	Language the customer transacts in
modifiedDate	date	Date the record was last updated in the accounting system.
priceLevel	string	Prices of products valid for this customer.
taxCode	string	Default tax code to be applied to the customer.
taxId	string	Tax number/registration number of the customer
corporateAddress	object	An object of corporate addresses
contact	object	An object of contact
billingAddress	object	An object of billing addresses
shippingAddress	object	An object of shipping addresses<
paymentTerms	object	An object of payment terms applicable to the customer
parent	object	An object of the parent company of the customer. Recorded only if the parent company is also a customer.
isubsidiary	object	An object of the subsidiary company of the customer. Recorded only if the subsidiary company is also a customer

corporateAddress

Field	Type	Description
corporateAddress.city	string	City of customer's corporate address
corporateAddress.country	string	Country of customer's corporate address
corporateAddress.id	string	Identifier of customer's corporate address in accounting system<
corporateAddress.line1		Address line1 of customer's corporate address
corporateAddress.line2	string	Address line2 of customer's corporate address
corporateAddress.phone	string	Phone number of customer's corporate address
corporateAddress.postalCode	string	Postal code of customer's corporate address
corporateAddress.province	string	Province/State of customer's corporate address

contact

Field	Type	Description
contact.address.city	string	City of primary contact at customer
contact.address.country	string	Country of primary contact at customer
contact.address.line1	string	Address line1 of primary contact at customer
contact.address.line2	string	Address line2 of primary contact at customer
contact.address.postalCode	string	Postal code of primary contact at customer
contact.address.province	string	Province/State of primary contact at customer
contact.email	string	Email ID of primary contact at customer
contact.fax	string	Fax of primary contact at customer
contact.middleName	string	Middle name of primary contact at customer
contact.mobile	string	Mobile number of primary contact at customer
contact.salutation	string	Salutation of primary contact at customer
contact.firstName	string	First name of primary contact at customer
contact.lastName	string	Last name of primary contact at customer
contact.phone	string	Phone number of primary contact at customer

billingAddress

Field	Type	Description
billingAddress.city	string	City of customer's billing address
billingAddress.contact.email	string	Email of contact at customer's billing address
billingAddress.contact.firstName	string	First name of contact at customer's billing address
billingAddress.contact.lastName	string	Last name of contact at customer's billing address
billingAddress.contact.middleName	string	Middle name of contact at customer's billing address
billingAddress.country	string	Country of customer's billing address
billingAddress.id	string	Identifier of customer's billing address in accounting system
billingAddress.line1	string	Address line1 of customer's billing address
billingAddress.line2	string	Address line2 of customer's billing address
billingAddress.postalCode	string	Postal code of customer's billing address
billingAddress.province	string	Province of customer's billing address
billingAddress.phone	string	Phone number of customer's billing address

shippingAddress

Field	Type	Description
shippingAddress.city	string	City of customer's shipping address
shippingAddress.contact.email	string	Email of contact at customer's shipping address
shippingAddress.contact.firstName	string	First name of contact at customer's shipping address
shippingAddress.contact.lastName	string	Last name of contact at customer's billing address
shippingAddress.contact.middleName	string	Middle name of contact at customer's billing address
shippingAddress.country	string	Country of customer's shipping address
shippingAddress.id	string	Identifier of customer's shipping address in accounting system
shippingAddress.line1	string	Address line1 of customer's shipping address
shippingAddress.line2	string	Address line2 of customer's shipping address
shippingAddress.province	string	Province of customer's shipping address
shippingAddress.phone	string	Phone number of customer's shipping address
shippingAddress.postalCode	string	Postal code of customer's shipping address

paymentTerms

Field	Type	Description
paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

parent

Field	Type	Description
parent.id	string	Identifier of the parent company of the customer.
parent.name	string	Name of the parent company of the customer.

subsidiary

Field	Type	Description
subsidiary.id	string	Identifier of the subsidiary company of the customer.
subsidiary.name	string	Name of the subsidiary company of the customer.

Vendors

Vendors
An individual or business that provides goods or services.

Field	Type	Description
externalId	string	Friendly reference of the vendor/reference of vendor from an external system
id	string	Identifier for the vendor, unique to the company in the accounting platform.
name	string	Name of the vendor as recorded in the accounting system, typically the company name.
active	boolean	Current state of the vendor
creditLimit	number	Current credit limit available from the vendor.
description	string	Any additional information about the vendor
webSite	string	Web address of the vendor.
account	string	The account linked to the vendor in the accounting system.
createdDate	date	Date the record was created in the accounting system.
currency	string	Currency in which the transactions are made with vendor
modifiedDate	date	Date the record was last updated in the accounting system.
totalOutstandingAmount	number	Amount paid to the vendor across all transactions.
bankAccountNumber	string	Bank Account Number of the vendor to which payments are made.
language	string	Language the vendor transacts in
type	string	Type of the vendor i.e. Primary, alternate etc
corporateAddress	object	An object of corporate addresses
contact	object	An object of contact
billingAddress	object	An object of billing addresses
shippingAddress	object	An object of shipping addresses
paymentTerms	object	An object of payment terms applicable to the customer
parent	object	An object of the parent company of the vendor. Recorded only if the parent company is also a vendor.
subsidiary	object	An object of the subsidiary company of the vendor. Recorded only if the subsidiary company is also a vendor.

corporateAddress

Field	Type	Description
corporateAddress.id	string	Identifier of vendor's corporate address in accounting system
corporateAddress.city	string	City of vendor's corporate address
corporateAddress.country	string	Country of vendor's corporate address
corporateAddress.line1	string	Address line1 of vendor's corporate address
corporateAddress.line2	string	Address line2 of vendor's corporate address
corporateAddress.phone	string	Phone number of vendor's corporate address
corporateAddress.postalCode	string	Postal code of vendor's corporate address
corporateAddress.province	string	Province/State of vendor's corporate address

contact

Field	Type	Description
contact.address.city	string	City of primary contact at vendor
contact.address.country	string	Country of primary contact at vendor
contact.address.line1	string	Address line1 of primary contact at vendor
contact.address.line2	string	Address line2 of primary contact at vendor
contact.address.postalCode	string	Postal code of primary contact at vendor
contact.address.province	string	Province/State of primary contact at vendor
contact.email	string	Email ID of primary contact at vendor
contact.fax	string	Fax of primary contact at vendor
contact.firstName	string	First name of primary contact at vendor
contact.lastName	string	Last name of primary contact at vendor
contact.middleName	string	Middle name of primary contact at vendor
contact.mobile	number	Mobile number of primary contact at vendor
contact.phone	string	Phone number of primary contact at vendor
contact.salutation	string	Salutation of primary contact at vendor

billingAddress

Field	Type	Description
billingAddress.city	string	City of vendor's billing address
billingAddress.country	string	Country of vendor's billing address
billingAddress.contact.firstName	string	First name of contact at vendor's billing address
billingAddress.id	string	Identifier of vendor's billing address in accounting system
billingAddress.contact.lastName	string	Last name of contact at vendor's billing address
billingAddress.line1	string	Address line1 of vendor's billing address
billingAddress.line2	string	Address line2 of vendor's billing address
billingAddress.contact.middleName	string	Middle name of contact at vendor's billing address
billingAddress.postalCode	string	Postal code of vendor's billing address
billingAddress.province	string	Province of vendor's billing address
billingAddress.contact.email	string	Email of contact at vendor's billing address
billingAddress.phone	string	Phone number of vendor's billing address

shippingAddress

Field	Type	Description
shippingAddress.city	string	City of vendor's shipping address
shippingAddress.country	string	Country of vendor's shipping address
shippingAddress.contact.firstName	string	First name of contact at vendor's shipping address
shippingAddress.id	string	Identifier of vendor's shipping address in accounting system
shippingAddress.contact.lastName	string	Last name of contact at vendor's billing address
shippingAddress.line1	string	Address line1 of vendor's shipping address
shippingAddress.line2	string	Address line2 of vendor's shipping address
shippingAddress.contact.middleName	string	Middle name of contact at vendor's billing address
shippingAddress.phone	string	Phone number of vendor's shipping address
shippingAddress.postalCode	string	Postal code of vendor's shipping address
shippingAddress.province	string	Province of vendor's shipping address
shippingAddress.contact.email	string	Email of contact at vendor's shipping address

parent

Field	Type	Description
parent.id	string	Identifier of the parent company of the vendor.
parent.name	string	Name of the parent company of the vendor.

subsidiary

Field	Type	Description
subsidiary.id	string	Identifier of the subsidiary company of the vendor.
subsidiary.name	string	Name of the subsidiary company of the vendor.

Product Bills

Product Bills
A commercial document issued by a seller/vendor, relating to a sale transaction and indicating the products, quantities and agreed costs for products the seller/vendor had provided along with the payment terms agreed.

Field	Type	Description
amount	number	Amount of the bill including tax.
currency	string	Currency of the bill
id	string	Identifier for the bill, unique to the bill in the accounting platform.
lines	array	An array of bill lines
billingAddress	object	An object of billing address
billDate	date	Date of the bill as recorded in the accounting platform.
dueDate	date	Date the supplier is due to be paid.
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applied to the bill
vendor	object	An object of vendor associated with the bill
createdDate	date	Date the record was created in the accounting system.
department	object	An object of department for which the products have been ordered.
externalId	string	Friendly reference of the bill/reference of bill (invoice) from an external system
lastPaidDate	date	The date of the last payment pertaining to this bill
location	object	An object of location for which the products have been ordered.
payment	array	An array of payment details pertaining to this bill
status	string	Current status of this bill.
taxAmount	number	Total tax amount on the bill
creditLimit	number	Current credit limit available from the vendor.
description	string	The description / reference / notes associated with the bill
discountiDate	date	The date of discount recorded in the accounting system for the bill
isOnHold	boolean	Indicator of whether the bill is on hold or active
purchase-order	object	An object of purchase order associated with this bill
totalAmountDue	number	Total amount that is due against the bill
totalAmountPaid	number	Total amount that is paid against the bill
discountAmount	number	Total discount amount applied on the bill
glPostDate	date	The date of posting of this transaction in the accounting system (General Ledger)
account	string	The General Ledger account in which this transaction is posted
landedCost	number	The bill of lading cost associated with this bill
exchangeRate	number	Rate between the currency of the bill and the base currency.
subTotal	number	The total amount of bill excluding any taxes

lines

lines[*].department.id	string	The unique id of the department for which the product has been ordered.
lines[*].department.name	string	The name of the department for which the product has been ordered.
lines[*].description	string	The description / notes pertaining to the product
lines[*].location.id	string	The unique id of the location for which the product has been ordered.
lines[*].location.name	string	The name of the location for which the product has been ordered.
lines[*].product.cost	number	The unit cost of the product
lines[*].product.id	string	The unique identifier of the product to which the line is linked.
lines[*].product.name	string	The name of the product to which the line is linked.
lines[*].product.purchaseUom	string	The purchasing unit of measurement of the product to which the line is linked.
lines[*].quantity	number	The quantity of the product received
lines[*].subTotal	number	Amount of the line, inclusive of discounts but exclusive of tax.
lines[*].taxAmount	number	Amount of tax for the line.
lines[*].taxCode	string	The applicable tax code pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The tax rate to which the line is linked.
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].customer.id	string	The unique identifier of the customer who has ordered the item
lines[*].customer.name	string	The name of the customer who has ordered the item
lines[*].discountAmount	number	The total applicable discount on this line item
lines[*].id	string	The unique identifier of the line in the bill
lines[*].billableStatus	string	The current state of the line

billingAddress:

billingAddress.city	string	City of vendor’s billing address
billingAddress.country	string	Country of vendor’s billing address
billingAddress.id	string	Identifier of vendor’s billing address in accounting system
billingAddress.line1	string	Address line1 of vendor’s billing address
billingAddress.line2	string	Address line2 of vendor’s billing address
billingAddress.phone	string	Phone number of vendor’s billing address
billingAddress.postalCode	string	Postal code of vendor’s billing address
billingAddress.province	string	Province of vendor’s billing address
billingAddress.contact.firstName	string	First name of contact at vendor’s billing address
billingAddress.contact.middleName	string	Middle name of contact at vendor’s billing address
billingAddress.contact.lastName	string	Last name of contact at vendor’s billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at vendor’s billing address
billingAddress.contact.email	string	Email of contact at vendor’s billing address

paymentTerms:

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

vendor:

vendor.id	string	Identifier of the supplier / vendor
vendor.name	string	Name of the supplier / vendor

department:

department.id	string	Identifier of the department
department.name	string	Name of the department

location:

location.id	string	Identifier of the location
location.name	string	Name of the location

payment:

payment[*].id	string	Identifier of the payment
payment[*].amount	number	Amount paid for this payment

purchase-order:

purchase-order.id

string

The unique identifier of purchase order

Expense Bills

Expense Bills
A commercial document issued by a seller/vendor, relating to a sale transaction and indicating the services, and agreed costs for services the seller/vendor had provided along with the payment terms agreed.

Field	Type	Description
amount	number	Amount of the bill including tax.
currency	string	Currency of the bill
id	string	Identifier for the bill, unique to the bill in the accounting platform.
lines	array	An array of bill lines
billingAddress	object	An object of billing address
billDate	date	Date of the bill as recorded in the accounting platform.
dueDate	date	Date the supplier is due to be paid.
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applied to the bill
vendor	object	An object of vendor associated with the bill
createdDate	date	Date the record was created in the accounting system.
department	object	An object of department for which the services have been ordered.
externalId	string	Friendly reference of the bill/reference of bill (invoice) from an external system
lastPaidDate	date	The date of the last payment pertaining to this bill
location	object	An object of location for which the services have been ordered.
payment	array	An array of payment details pertaining to this bill
status	string	Current status of this bill.
taxAmount	number	Total tax amount on the bill
creditLimit	number	Current credit limit available from the vendor.
description	string	The description / reference / notes associated with the bill
discountDate	date	The date of discount recorded in the accounting system for the bill
isOnHold	boolean	Indicator of whether the bill is on hold or active
purchase-order	object	An object of purchase order associated with this bill
totalAmountDue	number	Total amount that is due against the bill
totalAmountPaid	number	Total amount that is paid against the bill
discountAmount	number	Total discount amount applied on the bill
glPostDater	date	The date of posting of this transaction in the accounting system (General Ledger)
account	string	The General Ledger account in which this transaction is posted
landedCost	number	The bill of lading cost associated with this bill
exchangeRate	number	Rate between the currency of the bill and the base currency.
subTotal	number	The total amount of bill excluding any taxes

lines

lines[*].department.id	string	The unique id of the department for which the service has been ordered.
lines[*].department.name	string	The name of the department for which the services has been ordered.
lines[*].description	string	The description / notes pertaining to the service
lines[*].location.id	string	The unique id of the location for which the service has been ordered.
lines[*].location.name	string	The name of the location for which the service has been ordered.
lines[*].subTotal	number	Amount of the line, inclusive of discounts but exclusive of tax.
lines[*].taxAmount	number	Amount of tax for the line.
lines[*].taxCode	string	The applicable tax code pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The tax rate to which the line is linked.
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].customer.id	string	The unique identifier of the customer who has ordered the service
lines[*].customer.name	string	The name of the customer who has ordered the service
lines[*].discountAmount	number	The total applicable discount on this line
lines[*].id	string	The unique identifier of the line in the bill
lines[*].billableStatus	string	The current state of the line

billingAddress

billingAddress.city	string	City of vendor’s billing address
billingAddress.country	string	Country of vendor’s billing address
billingAddress.id	string	Identifier of vendor’s billing address in accounting system
billingAddress.line1	string	Address line1 of vendor’s billing address
billingAddress.line2	string	Address line2 of vendor’s billing address
billingAddress.phone	string	Phone number of vendor’s billing address
billingAddress.postalCode	string	Postal code of vendor’s billing address
billingAddress.province	string	Province of vendor’s billing address
billingAddress.contact.firstName	string	First name of contact at vendor’s billing address
billingAddress.contact.middleName	string	Middle name of contact at vendor’s billing address
billingAddress.contact.lastName	string	Last name of contact at vendor’s billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at vendor’s billing address
billingAddress.contact.email	string	Email of contact at vendor’s billing address

paymentTerms

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

vendor

vendor.id	string	Identifier of the supplier / vendor
vendor.name	string	Name of the supplier / vendor

department

department.id	string	Identifier of the department
department.name	string	Name of the department

location

location.id	string	Identifier of the location
location.name	string	Name of the location

payment

payment[*].id	string	Identifier of the payment
payment[*].amount	number	Amount paid for this payment

purchase-order

purchase-order.id

string

The unique identifier of purchase order

Product Invoices

Product Invoices
A commercial document issued to a customer, relating to a sale transaction and indicating the products, quantities and agreed prices for products shipped to the customer along with the payment terms agreed.

Field	Type	Description
amount	number	Amount of the invoice, inclusive of tax.
currency	string	Currency of the invoice.
id	string	Identifier for the invoice, unique to the company in the accounting platform.
lines	array	An array of invoice line items.
billingAddress	object	An object of billing address
invoiceDate	date	Date of the invoice as recorded in the accounting system.
dueDate	date	Date the customer is due to be paid by.
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applied to the invoice
customer	object	An object of customer associated with the invoice
createdDate	date	Date the record was created in the accounting system.
department	object	An object of department for which the products have been ordered.
externalId	string	Friendly reference of the invoice/reference of invoice from an external system
location	object	An object of location for which the products have been ordered.
payment	array	An array of payment details pertaining to the invoice
status	string	Current status of the invoice
taxAmount	number	Total tax amount against the invoice
taxCode	string	Default tax code applied to the invoice.
taxName	string	The tax description of the default tax to be applied to the invoice.
taxRate	string	Default tax rate applied to the invoice
description	string	The description / reference / notes associated with the invoice
discountDate	date	The date of discount recorded in the accounting system for the invoice
parentDocumentNumber	string	Customer purchase order/Sales order associated with this invoice
totalAmountDue	number	Total amount that is due on the invoice
totalAmountPaid	number	Total amount that is paid on the invoice
discountAmount	number	Numerical value of discounts applied to the invoice.
discountRate	string	Applied discount rate on the invoice
glPostDate	date	The date of posting of the transaction in the accounting system (General Ledger)
account	string	The General Ledger account in which the transaction is posted
language	string	Default language code used by the customer
exchangeRate	number	Rate between the currency of the invoice and the base currency.
subTotal	number	The total amount of invoice excluding taxes
fullPaymentDate	date	Date the invoice was marked as paid in the accounting system
shippingAddress	object	An object of shipping address
shippingCost	number	The cost incurred for shipping in the invoice
shippingMethod	string	The shipping method and terms used for the products in the invoice
shippingTaxAmount	number	The tax amount applied for shipping of the invoice products
shippingTaxCode	string	The default tax code applied for the shipping of the invoice products
shippingTaxRate	string	The default tax rate applied for the shipping of the invoice products
revRecEndDate	date	Revenue recognition end date
revRecStartDate	date	Revenue recognition start date
handlingCost	number	The inventory cost incurred for handling the products of the invoice
handlingTaxCode	string	The default tax code applied for the inventory handling of the invoice products
handlingTaxRate	string	The default tax rate applied for the inventory handling of the invoice products

lines

lines[*].department.id	string	The unique id of the department for which the product has been ordered.
lines[*].department.name	string	The name of the department for which the product has been ordered.
lines[*].description	string	The description / notes pertaining to the product
lines[*].location.id	string	The unique id of the location for which the product has been ordered.
lines[*].location.name	string	The name of the location for which the product has been ordered.
lines[*].product.cost	number	The unit cost of the product
lines[*].product.id	string	The unique identifier of the product in this line
lines[*].product.name	string	The name of the product in this line
lines[*].salesUom	string	The sales unit of measure of the product
lines[*].quantity	number	Number of units of product provided.
lines[*].subTotal	number	The total amount of the line excluding taxes
lines[*].taxAmount	number	Amount of tax for the line.
lines[*].taxCode	string	The applicable tax code pertaining to the line
lines[*].taxName	string	The applicable tax description pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The percentage of tax applicable to the line item
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].discountAmount	number	Numerical value of any discounts applied for the line
lines[*].discountRate	string	The total discount rate applied for the line
lines[*].id	string	The unique identifier of the line in the invoice
lines[*].isTaxable	boolean	Indicator whether the line is taxable or not

billingAddress

billingAddress.city	string	City of customer's billing address
billingAddress.country	string	Country of customer's billing address
billingAddress.id	string	Identifier of customer's billing address in accounting system
billingAddress.line1	string	Address line1 of customer's billing address
billingAddress.line2	string	Address line2 of customer's billing address
billingAddress.phone	string	Phone number of customer's billing address
billingAddress.postalCode	string	Postal code of customer's billing address
billingAddress.province	string	Province of customer's billing address
billingAddress.contact.firstName	string	First name of contact at customer's billing address
billingAddress.contact.middleName	string	Middle name of contact at customer's billing address
billingAddress.contact.lastName	string	Last name of contact at customer's billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at customer's billing address
billingAddress.contact.email	string	Email of contact at customer's billing address

shippingAddress

shippingAddress.city	string	City of customer's shipping address
shippingAddress.country	string	Country of customer's shipping address
shippingAddress.id	string	Identifier of customer's shipping address in accounting system
shippingAddress.line1	string	Address line1 of customer's shipping address
shippingAddress.line2	string	Address line2 of customer's shipping address
shippingAddress.phone	string	Phone number of customer's shipping address
shippingAddress.postalCode	string	Postal code of customer's shipping address
shippingAddress.province	string	Province of customer's shipping address
shippingAddress.contact.firstName	string	First name of contact at customer's shipping address
shippingAddress.contact.middleName	string	Middle name of contact at customer's shipping address
shippingAddress.contact.lastName	string	Last name of contact at customer's shipping address
shippingAddress.contact.salutation	string	Salutation of contact at customer's shipping address
shippingAddress.contact.email	string	Email of contact at customer's shipping address

paymentTerms

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

customer

customer.id	string	Identifier of the customer
customer.name	string	Name of the customer
customer.contact.address.city	string	The customer contact person’s city
customer.contact.address.country	string	The customer contact person’s country
customer.contact.address.line1	string	The customer contact person’s Address Line 1
customer.contact.address.line2	string	The customer contact person’s Address Line 2
customer.contact.address.postalCode	string	The customer contact person’s Postal Code
customer.contact.address.province	string	The customer contact person’s Province
customer.contact.email	string	The customer contact person’s email
customer.contact.firstName	string	The customer contact person’s First name
customer.contact.lastName	string	The customer contact person’s Last name
customer.contact.middleName	string	The customer contact person’s Middle name
customer.contact.mobile	string	The customer contact person’s mobile
customer.contact.phone	string	The customer contact person’s phone number

department

department.id	string	Identifier of the department
department.name	string	Name of the department

location

location.id	string	Identifier of the location
location.name	string	Name of the location

payment

payment[*].id	string	Identifier of the payment
payment[].lines[].amount	number	Amount paid(in the currency of the invoice) for this particular invoice
payment[].lines[].id	string	Unique payment line identifier
payment[*].currency	string	Currency of the payment amount
payment[*].paymentDate	date	The date of the payment made
payment[*].exchangeRate	number	The exchange rate used by the accounting for the payment amount to convert into local currency

Expense Invoices

Expense Invoices
A commercial document issued to a customer, relating to a sale transaction and indicating the services, and agreed prices for services provided to the customer along with the payment terms agreed.

lines

lines[*].department.id	string	The unique id of the department for which the services has been ordered.
lines[*].department.name	string	The name of the department for which the services has been ordered.
lines[*].description	string	The description / notes pertaining to the services
lines[*].location.id	string	The unique id of the location for which the services has been ordered.
lines[*].location.name	string	The name of the location for which the services has been ordered.
lines[*].subTotal	number	The total amount of the line excluding taxes
lines[*].taxAmount	number	Amount of tax for the line.
lines[*].taxCode	string	The applicable tax code pertaining to the line
lines[*].taxName	string	The applicable tax description pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The percentage of tax applicable to the line item
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].discountAmount	number	Numerical value of any discounts applied for the line
lines[*].discountRate	string	The total discount rate applied for the line
lines[*].id	string	The unique identifier of the line in the invoice
lines[*].isTaxable	boolean	Indicator whether the line is taxable or not

billingAddress

billingAddress.city	string	City of customer's billing address
billingAddress.country	string	Country of customer's billing address
billingAddress.id	string	Identifier of customer's billing address in accounting system
billingAddress.line1	string	Address line1 of customer's billing address
billingAddress.line2	string	Address line2 of customer's billing address
billingAddress.phone	string	Phone number of customer's billing address
billingAddress.postalCode	string	Postal code of customer's billing address
billingAddress.province	string	Province of customer's billing address
billingAddress.contact.firstName	string	First name of contact at customer's billing address
billingAddress.contact.middleName	string	Middle name of contact at customer's billing address
billingAddress.contact.lastName	string	Last name of contact at customer's billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at customer's billing address
billingAddress.contact.email	string	Email of contact at customer's billing address

paymentTerms

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

customer

customer.name	string	Name of the customer
customer.contact.address.city	string	The customer contact person’s city
customer.contact.adpdress.country	string	The customer contact person’s country
customer.contact.address.line1	string	The customer contact person’s Address Line 1
customer.contact.address.line2	string	The customer contact person’s Address Line 2
customer.contact.address.postalCode	string	The customer contact person’s Postal Code
customer.contact.address.province	string	The customer contact person’s Province
customer.contact.email	string	The customer contact person’s email
customer.contact.firstName	string	The customer contact person’s First name
customer.contact.lastName	string	The customer contact person’s Last name
customer.contact.middleName	string	The customer contact person’s Middle name
customer.contact.mobile	string	The customer contact person’s mobile
customer.contact.phone	string	The customer contact person’s phone number

department

department.id	string	Identifier of the department
department.name	string	Name of the department

location

location.id	string	Identifier of the location
location.name	string	Name of the location

payment

payment[*].id	string	Identifier of the payment
payment[].lines[].amount	number	Amount paid(in the currency of the invoice) for this particular invoice
payment[].lines[].id	string	Unique payment line identifier
payment[*].currency	string	Currency of the payment amount
payment[*].paymentDate	date	The date of the payment made
payment[*].exchangeRate	number	The exchange rate used by the accounting for the payment amount to convert into local currency

Product Purchase Orders

Product Purchase Orders
A purchase order is a commercial document and first official offer issued by a customer indicating types, quantities, and agreed prices for products.

Field	Type	Description
amount	number	Amount of the purchase order, inclusive of tax.
currency	string	Currency of the purchase order.
id	string	Identifier for the purchase order, unique to the purchase order in the accounting platform.
lines	array	An array of purchase order lines
billingAddress	object	An object of billing address
purchaseOrderDate	date	Date of the invoice as recorded in the accounting system.
dueDate	date	Date the purchase order is due to be paid by.
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applicable to the purchase order
vendor	object	An object of vendor associated with the purchase order
createdDate	date	Date the record was created in the accounting system.
bill	array	An array of bills associated with this purchase order
externalId	string	Friendly reference of the purchase order/reference of purchase order from an external system
status	string	Current status of this purchase order
taxAmount	number	Amount of tax on the purchase order.
taxCode	string	Default tax code applied to the purchase order.
description	string	The description / reference / notes associated with the purchase order
totalAmountDue	number	Total amount that is due on the purchase order
totalAmountPaid	number	Total amount that is paid on that purchase order
glPostDate	date	The date of posting of this transaction in the accounting system (General Ledger)
account	string	The General Ledger account in which this transaction is posted
exchangeRate	number	Rate between the currency of the purchase order and the base currency.
subTotal	number	Total amount of the purchase order excluding any taxes.
shippingAddress	object	An object of shipping address
shippingMethod	string	The shipping method and terms used for the products in the purchase order
creditLimit	number	Current credit limit available from the vendor.
shipDate	date	The expected delivery date of the products in purchase order

lines

lines[*].department.id	string	The unique id of the department for which the product has been ordered.
lines[*].department.name	string	The name of the department for which the product has been ordered.
lines[*].description	string	The description / notes pertaining to the item
lines[*].location.id	string	The unique id of the location for which the product has been ordered.
lines[*].location.name	string	The name of the location for which the product has been ordered.
lines[*].product.cost	number	The unit cost of the product in the line
lines[*].product.id	string	The unique identifier of the product in the line
lines[*].product.name	string	The name of the product in the line
lines[*].customer.id	string	The unique identifier of the customer for whom the product is being procured.
lines[*].customer.name	string	The name of the customer for whom the product is being procured.
lines[*].product.purchaseUom	string	The purchase unit of measure of the product
lines[*].orderedQuantity	number	The ordered quantity of the product in the purchase order
lines[*].subTotal	number	Amount of the line, inclusive of discounts but exclusive of tax.
lines[*].taxAmount	number	The total tax amount of the line
lines[*].taxCode	string	The applied tax code pertaining to the line
lines[*].taxName	string	The applied tax description pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The percentage of tax applied to the line
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].discountAmount	number	Numerical value of any discounts applied.
lines[*].discountRate	string	The total discount rate applied on this line
lines[*].id	string	The unique identifier of the line in the purchase order
lines[*].isTaxable	boolean	Indicator whether the line is taxable or not

billingAddress

billingAddress.city	string	City of supplier's billing address
billingAddress.country	string	Country of supplier's billing address
billingAddress.id	string	Identifier of supplier's billing address in accounting system
billingAddress.line1	string	Address line1 of supplier's billing address
billingAddress.line2	string	Address line2 of supplier's billing address
billingAddress.phone	string	Phone number of supplier's billing address
billingAddress.postalCode	string	Postal code of supplier's billing address
billingAddress.province	string	Province of supplier's billing address
billingAddress.contact.firstName	string	First name of contact at supplier's billing address
billingAddress.contact.middleName	string	Middle name of contact at supplier's billing address
billingAddress.contact.lastName	string	Last name of contact at supplier's billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at supplier's billing address
billingAddress.contact.email	string	Email of contact at supplier's billing address

shippingAddress

shippingAddress.city	string	City of supplier's shipping address
shippingAddress.country	string	Country of supplier's shipping address
shippingAddress.id	string	Identifier of supplier's shipping address in accounting system
shippingAddress.line1	string	Address line1 of supplier's shipping address
shippingAddress.line2	string	Address line2 of supplier's shipping address
shippingAddress.phone	string	Phone number of supplier's shipping address
shippingAddress.postalCode	string	Postal code of supplier's shipping address
shippingAddress.province	string	Province of supplier's shipping address
shippingAddress.contact.firstName	string	First name of contact at supplier's shipping address
shippingAddress.contact.middleName	string	Middle name of contact at supplier's shipping address
shippingAddress.contact.lastName	string	Last name of contact at supplier's shipping address
shippingAddress.contact.salutation	string	Salutation / Title of contact at supplier's shipping address
shippingAddress.contact.email	string	Email of contact at supplier's shipping address

paymentTerms

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

vendor

vendor.id	string	Identifier of the vendor
vendor.name	string	Name of the vendor
vendor.contact.address.city	string	The vendor contact person’s city
vendor.contact.address.country	string	The vendor contact person’s country
vendor.contact.address.line1	string	The vendor contact person’s Address Line 1
vendor.contact.address.line2	string	The vendor contact person’s Address Line 2
vendor.contact.address.postalCode	string	The vendor contact person’s Postal Code
vendor.contact.address.province	string	The vendor contact person’s Province
vendor.contact.email	string	The vendor contact person’s email
vendor.contact.firstName	string	The vendor contact person’s First name
vendor.contact.lastName	string	The vendor contact person’s Last name
vendor.contact.middleName	string	The vendor contact person’s Middle name
vendor.contact.mobile	string	The vendor contact person’s mobile
vendor.contact.phone	string	The vendor contact person’s phone number

bill

bill[*].id

string

Unique Identifier of the bill

Expense Purchase Orders

Expense Purchase Orders
A purchase order is a commercial document and first official offer issued by a customer indicating types and agreed prices for services.

Field	Type	Description
amount	number	Amount of the purchase order, inclusive of tax.
currency	string	Currency of the purchase order.
id	string	Identifier for the purchase order, unique to the purchase order in the accounting platform.
lines	array	An array of purchase order lines
billingAddress	object	An object of billing address
purchaseOrderDate	date	Date of the invoice as recorded in the accounting system.
dueDate	date	Date the purchase order is due to be paid by.
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applicable to the purchase order
vendor	object	An object of vendor associated with the purchase order
createdDate	date	Date the record was created in the accounting system.
bill	array	An array of bills associated with this purchase order
externalId	string	Friendly reference of the purchase order/reference of purchase order from an external system
status	string	Current status of this purchase order
taxAmount	number	Amount of tax on the purchase order.
taxCode	string	Default tax code applied to the purchase order.
description	string	The description / reference / notes associated with the purchase order
totalAmountDue	number	Total amount that is due on the purchase order
totalAmountPaid	number	Total amount that is paid on that purchase order
glPostDate	date	The date of posting of this transaction in the accounting system (General Ledger)
account	string	The General Ledger account in which this transaction is posted
exchangeRate	number	Rate between the currency of the purchase order and the base currency.
subTotal	number	Total amount of the purchase order excluding any taxes.
creditLimit	number	Current credit limit available from the vendor.

lines:

lines[*].department.id	string	The unique id of the department for which the services has been ordered.
lines[*].department.name	string	The name of the department for which the services has been ordered.
lines[*].description	string	The description / notes pertaining to the services
lines[*].location.id	string	The unique id of the location for which the services has been ordered.
lines[*].location.name	string	The name of the location for which the services has been ordered.
lines[*].customer.id	string	The unique identifier of the customer for whom the services is being procured.
lines[*].customer.name	string	The name of the customer for whom the services is being procured.
lines[*].subTotal	number	Amount of the line, inclusive of discounts but exclusive of tax.
lines[*].taxAmount	number	The total tax amount of the line
lines[*].taxCode	string	The applied tax code pertaining to the line
lines[*].taxName	string	The applied tax description pertaining to the line
lines[*].account	string	The applicable General ledger account where the line is recorded
lines[*].taxRate	string	The percentage of tax applied to the line
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].discountAmount	number	Numerical value of any discounts applied.
lines[*].discountRate	string	The total discount rate applied on this line
lines[*].id	string	The unique identifier of the line in the purchase order
lines[*].isTaxable	boolean	Indicator whether the line is taxable or not

billingAddress:

billingAddress.city	string	City of supplier's billing address
billingAddress.country	string	Country of supplier's billing address
billingAddress.id	string	Identifier of supplier's billing address in accounting system
billingAddress.line1	string	Address line1 of supplier's billing address
billingAddress.line2	string	Address line2 of supplier's billing address
billingAddress.phone	string	Phone number of supplier's billing address
billingAddress.postalCode	string	Postal code of supplier's billing address
billingAddress.province	string	Province of supplier's billing address
billingAddress.contact.firstName	string	First name of contact at supplier's billing address
billingAddress.contact.middleName	string	Middle name of contact at supplier's billing address
billingAddress.contact.lastName	string	Last name of contact at supplier's billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at supplier's billing address
billingAddress.contact.email	string	Email of contact at supplier's billing address

paymentTerms:

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

vendor:

vendor.id	string	Identifier of the vendor
vendor.name	string	Name of the vendor
vendor.contact.address.city	string	The vendor contact person’s city
vendor.contact.address.country	string	The vendor contact person’s country
vendor.contact.address.line1	string	The vendor contact person’s Address Line 1
vendor.contact.address.line2	string	The vendor contact person’s Address Line 2
vendor.contact.address.postalCode	string	The vendor contact person’s Postal Code
vendor.contact.address.province	string	The vendor contact person’s Province
vendor.contact.email	string	The vendor contact person’s email
vendor.contact.firstName	string	The vendor contact person’s First name
vendor.contact.lastName	string	The vendor contact person’s Last name
vendor.contact.middleName	string	The vendor contact person’s Middle name
vendor.contact.mobile	string	The vendor contact person’s mobile
vendor.contact.phone	string	The vendor contact person’s phone number

bill:

bill[*].id

string

Unique Identifier of the bill

Sales Orders

Sales Orders
A sales order is a commercial document and the first official offer received by a supplier/vendor indicating types and agreed prices for the product or service.

Field	Type	Description
amount	number	Amount of the sales order, inclusive of tax.
currency	string	Currency of the sales order
id	string	Identifier for the sales order, unique to the sales order in the accounting platform.
lines	array	An array of sales order line items.
billingAddress	object	An object of billing address
salesOrderDate	date	Date of the sales order as recorded in the accounting system.
isTaxable	boolean	The indicator which shows whether the amount and items are taxable or not
dueDate	date	Date when the payment of the sales order is due
modifiedDate	date	Date the record was last updated in the accounting system.
paymentTerms	object	An object of Payment Terms applicable to the sales order
customer	object	An object of customer associated with the sales order
createdDate	date	Date the record was created in the accounting system.
department	object	An object of department for which the products have
externalId	string	Friendly reference of the sales order/reference of sales order from an external system
payment	array	An array of payment details pertaining to this sales order
status	string	Current status of the sales order transaction
taxAmount	number	Amount of tax on the sales order.
taxCode	string	Default tax code applied to the sales order.
taxRate	string	Default tax rate applied to the sales order
description	string	The description / reference / notes associated with the sales order
customerPONumber	string	Customer purchase order associated with this sales order
totalOutstandingAmount	number	Total amount that is outstanding on the sales order
exchangeRate	number	Rate between the currency of the invoice and the base currency
subTotal	number	Total amount of the invoice excluding any taxes.
shippingAddress	object	An object of shipping address
shippingCost	number	The cost incurred for shipping in the sales order
requestedShipDate	date	The requested date of delivery of the items in the sales order

lines:

lines[*].department.id	string	The unique id of the department for which the product has been ordered.
lines[*].department.name	string	The name of the department for which the product has been ordered.
lines[*].description	string	The description / notes pertaining to the item
lines[*].location.id	string	The unique id of the location for which the product has been ordered.
lines[*].location.name	string	The name of the department for which the product has been ordered.
lines[*].priceLevel.price	number	The unit cost of the product
lines[*].product.id	string	The unique identifier of the product in this line
lines[*].product.name	string	The name of the product in this line
lines[*].product.salesUom	string	The sales unit of measure of the product
lines[*].orderQuantity	number	The ordered quantity of the product in the sales order
lines[*].subTotal	number	Amount of the line excluding taxes
lines[*].taxAmount	number	The total tax amount of the line
lines[*].taxCode	string	The applied tax code pertaining to the line item
lines[*].taxRate	string	The percentage of tax applied to the line item
lines[*].totalAmount	number	The total amount of the line including taxes
lines[*].discountAmount	number	Numerical value of any discounts applied.
lines[*].id	string	The unique identifier of the line in the sales order

billingAddress:

billingAddress.city	string	City of customer's billing address
billingAddress.country	string	Country of customer's billing address
billingAddress.id	string	Identifier of customer's billing address in accounting system
billingAddress.line1	string	Address line1 of customer's billing address
billingAddress.line2	string	Address line2 of customer's billing address
billingAddress.phone	string	Phone number of customer's billing address
billingAddress.postalCode	string	Postal code of customer's billing address
billingAddress.province	string	Province of customer's billing address
billingAddress.contact.firstName	string	First name of contact at customer's billing address
billingAddress.contact.middleName	string	Middle name of contact at customer's billing address
billingAddress.contact.lastName	string	Last name of contact at customer's billing address
billingAddress.contact.salutation	string	Salutation / Title of contact at customer's billing address
billingAddress.contact.email	string	Email of contact at customer's billing address

shippingAddress:

shippingAddress.city	string	City of customer's shipping address
shippingAddress.country	string	Country of customer's shipping address
shippingAddress.id	string	Identifier of customer's shipping address in accounting system
shippingAddress.line1	string	Address line1 of customer's shipping address
shippingAddress.line2	string	Address line2 of customer's shipping address
shippingAddress.phone	string	Phone number of customer's shipping address
shippingAddress.postalCode	string	Postal code of customer's shipping address
shippingAddress.province	string	Province of customer's shipping address
shippingAddress.contact.firstName	string	First name of contact at customer's shipping address
shippingAddress.contact.middleName	string	Middle name of contact at customer's shipping address
shippingAddress.contact.lastName	string	Last name of contact at customer's shipping address
shippingAddress.contact.salutation	string	Salutation / Title of contact at customer's shipping address
shippingAddress.contact.email	string	Email of contact at customer's shipping address

paymentTerms:

paymentTerms.id	string	Identifier of the payment terms.
paymentTerms.name	string	Name of the payment terms.

customer:

customer.id	string	Identifier of the customer
customer.name	string	Name of the customer
customer.contact.address.city	string	The customer contact person’s city
customer.contact.address.country	string	The customer contact person’s country
customer.contact.address.line1	string	The customer contact person’s Address Line 1
customer.contact.address.line2	string	The customer contact person’s Address Line 2
customer.contact.address.postalCode	string	The customer contact person’s Postal Code
customer.contact.address.province	string	The customer contact person’s Province
customer.contact.email	string	The customer contact person’s email
customer.contact.firstName	string	The customer contact person’s First name
customer.contact.lastName	string	The customer contact person’s Last name
customer.contact.middleName	string	The customer contact person’s Middle name
customer.contact.mobile	string	The customer contact person’s mobile
customer.contact.phone	string	The customer contact person’s phone number

AR Payments

AR Payments
Proceeds or payments received from the customers who purchased the goods or services on credit.

Field	Type	Description
externalId	string	Friendly reference of the payment/reference of payment from an external system
id	string	Identifier for the payment, unique to the company in the accounting platform.
amount	number	Amount of the payment in the payment currency.
customer	object	An object of customer associated with the payment
paymentDate	date	The date of the payment made
glPostDate	date	The date of posting of this transaction in the accounting system (General Ledger)
exchangeRate	number	Rate to convert the total amount of the payment into the base currency
lines	array	An array of payment lines
currency	string	Currency of the payment
description	string	Any additional information about the payment
totalOutstandingAmount	number	Total amount outstanding from the customer.
bankAccount	string	The bank account in which the payment was made
createdDate	date	Date the record was created in the accounting system.
paymentReceiptDate	date	The date payment is received
account	string	The AR account in the accounting system linked to this transaction
modifiedDate	date	Date the record was last updated in the accounting system.
reference	string	A friendly payment reference
checkNumber	string	The cheque number in case payment was made by cheque
cardNumber	string	The card number in case payment was made by card
cardName	string	The card name in case payment was made by card
cardExpiry	string	The card expiry date in case payment was made by card
paymentMethod	string	The mode of payment

customer:

customer.id	string	Identifier of the customer
customer.name	string	Name of the customer

lines:

lines[*].invoiceNumber	string	The invoice number associated with the payment
lines[*].type	string	The type of payment made
lines[*].amountDueAgainstInvoice	number	The total amount due against invoice
lines[*].amount	number	The amount paid against invoice in the payment
lines[*].id	string	The unique identifier of this line in the sales order
lines[*].discountAvailable	number	The total applicable discount amount on this payment
lines[*].discountDate	date	The date of the discount applied on the payment

Ledger Accounts

Ledger Accounts
A ledger account contains a record of business transactions. It is a separate record within the general ledger that is assigned to a specific asset, liability, equity, revenue, or expense type.

Field	Type	Description
account	number	Reference given to each nominal ledger account for a business. It ensures money is allocated to the correct account.
accName	string	Name of the ledger account
accCategory	string	Main category of the ledger account
accSubCategory	string	Type of ledger account (sub category)
description	string	Additional details (description) for the account
tranType	string	The type of transaction made to this account - Debit or Credit
id	number	Identifier for the account, unique for the company.
status	string	The current state of the account
taxable	boolean	Indicator to display whether the amount in the account is taxable or not
taxCode	string	The default tax code associated with this account
createdDate	string	Date the record was created in the accounting system.
modifiedDate	string	Date the record was last updated in the accounting system.
cashFlowRate	string	The type of exchange rate that is used to translate foreign currency amounts for this account in the cash flow statement.
currency	string	Currency of the account.
exchangeRate	string	The exchange rate used in the accounting system in order to convert the amount into the home currency
externalId	string	Friendly reference of the account (from external system)
generalRate	string	The type of exchange rate that is used to translate foreign currency amounts for this account in the income statement, balance sheet, and other general purposes.
amount	number	Current balance in the account
parentAcc.id	string	The unique identifier of the parent account of this ledger account
parentAcc.name	string	The name of the parent account of this ledger account
parentAcc.type	string	The type of the parent account of this ledger account
requireLoc	boolean	Indicator to display whether the access of this account is restricted to a location
location.id	string	The location unique identifier that has access privileges to this account
location.name	string	The location name that has access privileges to this account
location.type	string	The location type that has access privileges to this account
requireDept	boolean	Indicator to display whether the access of this account is restricted to a department
department.name	string	The department name that has access privileges to this account
department.type	string