Service - CommerceAccounting Purchase

Overview

Handle links between purchases and Accounting records.

Repository

...

Object Schemas

Additional Information

Per Service Schemas

comAccPurchaseLink

{
	objectType: "comAccPurchaseLink",
    generatedBy: "userGenerated",
	canDelete: false,
	belongTo: {
		serviceTag: "CommerceAccountingLink",
		objectType: "comAccLinkByBusiness"
	},
	addOnDataStructure: [],
	storageResources: {
        "myGraph":{
          "storageType": "graph",
          "graphServerTag": "GraphHandler"
        },
		"dynamo": {
			"storageType": "dynamoDB",
			"tableName": "comAccPurchaseLink",
		}
    },
    fieldNames: {
		businessId:{
			fromObjType:{
			  serviceTag: "CommerceAccountingLink",
			  objectType: "comAccLinkByBusiness" 
			},
        },
		organizationId: {
			fromObjType:{
			  serviceTag: "CommerceAccountingLink",
			  objectType: "comAccLinkByOrganization" 
			},
		},
        accountLinkTag:{   // type of link: inputVAT|salesTax|vatTax..
            type: "string",
			requriedOnCreate: true,
			storageResourceTags: ['myGraph','dynamo']
        }		
        accountId:{
            type: "string",
			requriedOnCreate: true,
			storageResourceTags: ['myGraph','dynamo']
        }
    },
    identifiers: [
		{
			type: "partitionKey",
			fieldNames: ["businessId", "organizationId"],
			name: "comAccLinkId",
		},
		{
			type: "sortKey",
			fieldName: "accountLinkTag"
		},
    ]
}

• sets which Accounting accountId journal entries are added to

comAccPurchase

{
	objectType: "comAccPurchase",
    generatedBy: "systemGenerated",
	canDelete: false,
    addOnDataStructure: [],
	storageResources: {
		"dynamo": {
			"storageType": "dynamoDB",
			"tableName": "comAccPurchase",
		}
    },
    fieldNames: {
		// businessId,
		// organizationId,
		// purchaseId,

		// record lock eg: prefix: "updatePurchase"
		// updatePurchase_status: {requiredOnCreate: true}, // open|lock, 
		// updatePurchase_uniqueRequestId: {requiredOnCreate: true},
		// updatePurchase_timestamp: {requiredOnCreate: true},

		journalId: {
			type: "string",
			optionalOnCreate: true,
			canUpdate: true,
			storageResourceTags: ["dynamo"],
		},
    },
    identifiers: [
		{
			type: "partitionKey",
			fieldNames: ["businessId", "organizationId"],
			name: "comAccLinkId",
		},
		{
			type: "sortKey",
			fieldName: "purchaseId"
		},
    ]
}

comAccPurchaseLineItem

{
	objectType: "comAccPurchaseLineItem",
	generatedBy: "systemGenerated",
    canDelete: false,
	addOnDataStructure: [],
	storageResources: {
		"dynamo": {
			"storageType": "dynamoDB",
			"tableName": "comAccPurchaseLineItem",
		}
    },
    fieldNames: {
		// businessId
		// organizationId
		// purchaseId,
		// purchaseLineItemId,
		// accountId
		// lineItemQuantity
		// lineItemUnitPricelineItemUnitPrice
		// entryId // not sure want to record because multiple lineItems might be in the same entryId
    },
    identifiers: [
		{
			type: "partitionKey",
			fieldNames: ["businessId", "organizationId", "purchaseId"],
			name: "comAccLinkPurchaseId
		},
		{
			type: "sortKey",
			fieldName: "purchaseLineItemId"
		},
    ]
}

• This table might not be needed because we do not create a journal entry per line item, we make a compound journal entry per purchase
• Keep it for now so we can reconcile Commerce data matches ComAcc data

Relationships

...

flowSchemas

createPurchase

• when creating a purchase, iterate purchaseLineItems to decide which journal entries are created
• accountsPayable accountId comes from Service - CommerceAccounting Vendor
• each purchaseLineItem checks it's type then finds accountId from coresponding comAcc service

Example request param from Commerce

{
	belongToIdentifiers: {
	  businessId: "xxx"
	},
	purchaseId: "",
	vendorId: "",
    timestamp: 1111111,
	purchaseCurrencyId: "",
	inventoryLocationId: "", // required if have any inventory/?assets
	purchaseLineItems: {
		{purchaseLineItemId}: {

            inventoryId: "",
            inventoryTemplateId: "",
            // or
            expenseId: "",
            // or
            servicesId: "",
            servicesTemplateId: "",
            // or
            freightInId: "",
            // or

            otherPurchaseItemId: "",
            

			type: "", // inventory|expense|services|freight|salesTax|vatTax|other
			subType: "", // inventory: goods|intangibleGoods|rawMaterial|asset|intangibleAsset, expense: pointInTime|overTime, services: pointInTime|overTime, freight: standard, other: standard

			lineItemQuantity: 1,
			lineItemUnitPrice: "2.00"
		},
		//...
	}
}

updatePurchase

• make adjustment to journal entries when purchaseLineItemId changes
• handle removal of purchase/journal entries, or creation of new entries
• basically re-calculate all entries and check against existing
• each journalId must check Accounting that it's period/s are not locked, if locked return error, cannot make update

Working documents

CommerceAccounting Purchase