JSON Schemas
Customer
{
"ID": "",
"ExternalID": "",
"Name": "",
"FullName": "",
"ParentRef": {
"ID": "",
"FullName": ""
},
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"BillAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"ShipAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"AccountNumber": "",
"Balance": 0.0,
"IsActive": true
}
Vendor
{
"ID": "",
"Name": "" (required),
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"Address": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"AccountNumber": "",
"IsActive": true
}
Item
{
"ID": "",
"ExternalID": "",
"Name": "",
"FullName": "" (required),
"ParentRef": {
"ID": "",
"FullName": ""
},
"Description": "",
"Cost": 0.0,
"SalesPrice": 0.0,
"IsTaxable": true,
"PreferredVendor": {
"ID": "",
"Name": "",
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"Address": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"AccountNumber": "",
"IsActive": true
},
"Manufacturer": "",
"QtyAvailable": 1,
"IsActive": true,
"ManufacturerPartNumber": "",
"COGSAcctRef": {
"ID": "",
"FullName": ""
},
"AssetAcctRef": {
"ID": "",
"FullName": ""
},
"IncomeAcctRef":{
"ID": "",
"FullName": ""
}
}
Employee
{
"ID": "",
"ExternalID": "",
"Name": "" (required),
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"Address": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"IsActive": true,
"Department": "",
"SSN": "",
"EmployeeNumber": "",
"HireDate": "",
"TerminationDate": "",
"JobTitle": ""
}
Account
{
"ID": "",
"ExternalID": "",
"Name": "" (required),
"FullName": "",
"AccountNumber": "",
"Description": "",
"BankNumber": "",
"ParentRef": {
"ID": "",
"FullName": ""
},
"Balance": 0.0,
"IsActive": true,
"AccountType": ""
}
Class
{
"ID": "",
"FullName": "" (required),
"IsActive": true
}
Check
{
"ID": "",
"ExternalID": "",
"TxnNumber": "",
"IsCharge": false,
'ToBePrintedLater': false,
"AccountRef": {
"ID": "",
"FullName": "" (required)
},
"PayeeEntityRef": {
"ID": "",
"FullName": "" (required)
},
"Address": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"TxnDate": "",
"RefNumber": "",
"Memo": "",
"Amount": 0.0 (required),
"ItemLineItems": [
{
"ItemRef": {
"ID": "",
"FullName": "" (required)
},
"Description": "",
"Quantity": 0.0,
"Cost": 0.0,
"Amount": 0.0,
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": "false",
"ClassRef": {
"ID": "",
"FullName": ""
}
}
],
"ExpLineItems": [
{
"AccountRef": {
"ID": "",
"FullName": "" (required)
},
"Amount": 0.0 (required),
"Memo": "",
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": "false",
"ClassRef": {
"ID": "",
"FullName": ""
}
}
]
}
Expense
{
"ID": "",
"ExternalID": "",
"RefNumber": "",
"Memo": "",
"TxnDate": "",
"Vendor": {
"ID": "",
"Name": "" (required),
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"Address": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"AccountNumber": "",
"IsActive": true
},
"APAccountRef": {
"ID": "",
"FullName": "" (required)
},
"ItemLineItems": [
{
"Item": {
"ID": "",
"FullName": "" (required)
},
"Description": "",
"Quantity": 0.0,
"Cost": 0.0,
"Amount": 0.0,
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": "false",
"ClassRef": {
"ID": "",
"FullName": ""
}
}
],
"ExpLineItems": [
{
"AccountRef": {
"ID": "",
"FullName": "" (required)
},
"Amount": 0.0,
"Memo": "",
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": "false",
"ClassRef": {
"ID": "",
"FullName": ""
}
}
]
}
Invoice
{
"ID": "",
"RefNumber": "",
"ExternalID": "",
"PONumber": "",
"BalanceRemaining": 0,
"SubTotal": 0,
"DueDate": "2016-01-01T00:00:00",
"TxnDate": "2016-01-01T00:00:00",
"ToBePrinted": false,
"ToBeEmailed": false,
"LineItems": [
{
"Item": {
"ID": "",
"ExternalID": "",
"Name": "" (required),
"Manufacturer": "",
"ItemCost": 0,
"ItemPrice": 0 (required)
},
"Amount": 0,
"Quantity": 0,
"Rate": 0,
"InvDesc": "",
"RatePercent": 0,
"ServiceDate": "0001-01-01T00:00:00",
"IsTaxable": true,
"Class": ""
}
],
"TermsRef": {
"ID": "",
"FullName": ""
},
"Other": "",
"Memo": "",
"Class": "",
"SalesRep": {
"ID": "",
"FullName": ""
},
"Customer": {
"ID": "",
"ExternalID": "",
"Name": "",
"FullName": "" (required),
"JobTitle": "",
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"BillAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"ShipAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"TaxRate": 0,
"AccountNumber": ""
}
}
Journal Entry
{
'ID': 'ID',
'ExternalID': 'ExternalID',
'TxnDate': 'TxnDate',
'CreditList': 'CreditList[]
{
'Amount': 'Amount',
'Memo': 'Memo',
'IsBillable': 'IsBillable',
'AccountRef': 'Account{}
{
'ID': 'ID',
'FullName': 'FullName'
}',
'EntityRef': 'Entity{}
{
'ID': 'ID',
'FullName': 'FullName',
}',
'ClassRef': 'Class{}
{
'ID': 'ID',
'FullName': 'FullName'
}'
}',
'DebitList': 'DebitList[]
{
'Amount': 'Amount',
'Memo': 'Memo',
'IsBillable': 'IsBillable',
'AccountRef': 'Account{}
{
'ID': 'ID',
'FullName': 'FullName'
}',
'EntityRef': 'Entity{}
{
'ID': 'ID',
'FullName': 'FullName',
}',
'ClassRef': 'Class{}
{
'ID': 'ID',
'FullName': 'FullName'
}'
}'
}
Sales Receipt
{
"ID": "",
"RefNumber": "",
"ExternalID": "",
"PONumber": "",
"BalanceRemaining": 0,
"SubTotal": 0,
"DueDate": "2016-01-01T00:00:00",
"TxnDate": "2016-01-01T00:00:00",
"ToBePrinted": false,
"ToBeEmailed": false,
"PaymentMethodRef": {
"ID": "",
"FullName": ""
},
"LineItems": [
{
"Item": {
"ID": "",
"ExternalID": "",
"Name": "" (required),
"Manufacturer": "",
"ItemCost": 0,
"ItemPrice": 0
},
"Amount": 0,
"Quantity": 0,
"Rate": 0,
"InvDesc": "",
"RatePercent": 0,
"ServiceDate": "0001-01-01T00:00:00",
"IsTaxable": true,
"Class": ""
}
],
"TermsRef": {
"ID": "",
"FullName": ""
},
"Other": "",
"Memo": "",
"Class": "",
"SalesRep": {
"ID": "",
"FullName": ""
},
"Customer": {
"ID": "",
"ExternalID": "",
"Name": "",
"FullName": "" (required),
"JobTitle": "",
"CompanyName": "",
"Salutation": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Suffix": "",
"BillAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"ShipAddress": {
"Addr1": "",
"Addr2": "",
"Addr3": "",
"Addr4": "",
"Addr5": "",
"City": "",
"State": "",
"PostalCode": "",
"Country": ""
},
"Phone": "",
"Mobile": "",
"AltPhone": "",
"Email": "",
"Contact": "",
"AltContact": "",
"TaxRate": 0,
"AccountNumber": ""
}
}
Bill Payment
{
"ID": "",
"IsCheck": "true/false",
"APAccount": {
"ID": "",
"FullName": ""
},
"Memo": "",
"Account": {
"ID": "",
"FullName": "" (required)
},
"Vendor": {
"ID": "",
"FullName": ""
},
"TxnDate": "",
"TxnList": [{
"ID": "" (required),
"Amount": 0
}]
}
Report
{
"ReportType": 0,
"StartDate": "",
"EndDate": "",
"Columns": "",
"ReportLineData": {
"EntityRef": {
"FullName": "",
"ID": ""
},
"Values": ""
}
}
Vendor Credit
{
"ID": "",
"ExternalID": "",
"RefNum": "",
"Memo": "",
"TxnDate": "",
"VendorRef": {
"ID": "",
"Name": ""
},
"APAccountRef": {
"ID": "",
"FullName": ""
},
"ItemLineItems": [{
"Item": {
"ID": "",
"FullName": ""
},
"Description": "",
"Quantity": 0,
"Cost": 0,
"Amount": 0,
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": false,
"ClassRef": {
"ID": "",
"FullName": ""
}
}],
"ExpLineItems": [{
"AccountRef": {
"ID": "",
"FullName": ""
},
"Amount": 0,
"Memo": "",
"CustomerRef": {
"ID": "",
"FullName": ""
},
"IsBillable": false,
"ClassRef": {
"ID": "",
"FullName": ""
}
}]
}
Updated over 7 years ago