Skip to content
Developerhome
Product homepage
Sage Network API

CreditMemoAppliedModel

  Less than to read

Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Sage Network creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.

Methods

The following API methods use this data model.

uuid, read-only

The unique ID of this record, automatically assigned by Sage Network when this record is added to the Sage Network.

For the ID of this record in its originating financial system, see ErpKey.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Sage Network account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

erpWriteStatus

ErpWriteStatuses, read-only

Possible statuses for a record that supports ERP write.

erpWriteStatusName

string, nullable, read-only

The name of the ErpWriteStatus for this credit memo application

created

date-time, read-only

Date credit memo applied record was created.

createdUserId

uuid, read-only

The id of the user who created this applied credit memo.

modified

date-time, read-only

Date credit memo applied record was modified.

modifiedUserId

uuid, read-only

The id of the user who modified this applied credit memo.

appEnrollmentId

uuid, nullable, read-only

The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.

sourceModifiedDate

date-time, nullable, read-only

The date on which this record was last modified in source ERP.

creditMemoInvoice

InvoiceModel, nullable, read-only

The credit memo invoice associated with this applied credit memo

invoice

InvoiceModel, nullable, read-only

The invoice associated with this applied credit memo

Required Fields

invoiceId

uuid

The Sage Network ID of the Invoice to which this credit memo was applied. This Invoice’s outstanding balance was reduced by the value of the field CreditMemoAppliedAmount on the date ApplyToInvoiceDate.

Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this credit memo to reduce the balance of the invoice PO1000578. The InvoiceErpKey is the Sage Network ID number of Invoice PO1000578.

creditMemoInvoiceId

uuid

The Sage Network ID of the Invoice of type “Credit Memo” that was consumed in this payment application event.

Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this credit memo to reduce the balance of the invoice PO1000578. The CreditMemoInvoiceId is the Sage Network ID number of Invoice CM000123.

entryNumber

int32

Reference number for the applied credit memo.

applyToInvoiceDate

date-time

The date on which this credit memo was applied to the Invoice represented by InvoiceId.

creditMemoAppliedAmount

double

The amount of the credit memo that was applied to the Invoice represented by InvoiceId.

Optional Fields

erpKey

string, nullable, max 255 characters

The unique ID of this record as it was known in its originating financial system.

If this company record was imported from a financial system, it will have the value ErpKey set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be null.

For more information, see Identity Columns.

Included Collections

These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.

attachments

AttachmentModel[], nullable, read-only

A collection of attachments linked to this record. To retrieve this collection, specify Attachments in the include parameter when retrieving data.

To create an attachment, use the Upload Attachment endpoint with the TableKey to CreditMemoApplied and the ObjectKey set to the CreditMemoAppliedId for this record. For more information on extensibility, see linking extensible metadata to objects.

notes

NoteModel[], nullable, read-only

A collection of notes linked to this record. To retrieve this collection, specify Notes in the include parameter when retrieving data.

To create a note, use the Create Note endpoint with the TableKey to CreditMemoApplied and the ObjectKey set to the CreditMemoAppliedId for this record. For more information on extensibility, see linking extensible metadata to objects.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify CustomFieldDefinitions in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field endpoint with the TableKey to CreditMemoApplied and the ObjectKey set to the CreditMemoAppliedId for this record. For more information on extensibility, see linking extensible metadata to objects.

customFieldValues

CustomFieldValueModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify CustomFieldValues in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field endpoint with the TableKey to CreditMemoApplied and the ObjectKey set to the CreditMemoAppliedId for this record. For more information on extensibility, see linking extensible metadata to objects.