Service - CommerceAccounting Customer Payment

Overview

Handle payments by customers.

Repository

...

Object Schemas

Additional Information

Per Service Schemas

{
	objectType: "comAccCustomerPaymentLink",
    generatedBy: "userGenerated",
	canDelete: false,
	belongTo: {
		serviceTag: "CommerceAccountingLink",
		objectType: "comAccLinkByBusiness"
	},
	addOnDataStructure: [],
	storageResources: {
		"dynamo": {
			"storageType": "dynamoDB",
			"tableName": "comAccCustomerPaymentLink",
		}
    },
    fieldNames: {
		// businessId
		// organizationId
		// customerId
		// accountLinkTag // type of link: ..
		// accountId
    },
    identifiers: [
		{
			type: "partitionKey",
			fieldNames: ["businessId", "organizationId", "customerId"],
			name: "comAccLinkExpId",
		},
		{
			type: "sortKey",
			fieldName: "accountLinkTag"
		},
    ]
}

comAccCustomerPayment

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

		// record lock eg: prefix: "updateCustomerPayment"
		// updateCustomerPayment_status: {requiredOnCreate: true}, // open|lock, 
		// updateCustomerPayment_uniqueRequestId: {requiredOnCreate: true},
		// updateCustomerPayment_timestamp: {requiredOnCreate: true},

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

• maintains a link between customerPaymentId and journalIds, so can adjust if changes made to payment

Relationships

...

flowSchemas

customerPaymentCreated

• when creating a customer payment add journal entries

customerPaymentChange

• make adjustment to journal entries
• need to check for locked records

Working documents

CommerceAccounting Customer Payment