Credit Memos
Credit Memo represents a document issued by the vendor to the buyer, indicating a refund or credits to their account. It includes information about its associated invoice, total due, payments, tax, and other relevant information.
Schema​
CreditMemo​
| Name | Type | Description | Example |
|---|---|---|---|
| id | ID | Unique identifier for credit memos | "ckmnpybisiy5x08abky4g2d1f" |
| createdAt | DateTime | When this credit memo was created | "2021-03-24 17:26:46.983Z" |
| updatedAt | DateTime | When this credit memo was last updated | "2021-03-24 17:26:46.983Z" |
| creditMemoNumber | string? | User-defined value to identify this credit memo | "Memo-1234" |
| invoiceId | ID | The ID of the invoice this credit memo is attached to | "clqzdedh90012b24xndju75yu" |
| payments | float? | The amount of payments on this credit memo | 10.00 |
| shippingCostFloat | float? | The cost of shipping | 10.00 |
| subtotal | float? | Subtotal of the invoice before addition of other costs such as taxes | 10.00 |
| tax | float? | The amount of tax on the credit memo | 10.00 |
| totalDue | float? | The total amount due | 10.00 |
| invoice | Invoice? | Invoice this item is attached to | See Invoice docs |
| creditMemoItems | CreditMemoItem[] | Items listed in the credit memo | See CreditMemoItem |
CreditMemoItem​
| Name | Type | Description | Example |
|---|---|---|---|
| id | ID | Unique identifier for the credit memo item | "clly7zx46000008l46u694ybg" |
| createdAt | DateTime | Timestamp when the credit memo item was created | "2021-03-24 17:26:46.983Z" |
| updatedAt | DateTime | Timestamp when the credit memo item was last updated | "2021-03-24 17:26:46.983Z" |
| creditMemoId | ID | The ID of the credit memo this credit memo item is attached to | "clpkd1sgv0000uy4xzw6r90wi" |
| extPriceFloat | float? | EXT price of the credit memo item | 100.0 |
| invoiceItemId | ID | The ID of the invoice item this credit memo item is attached to | "clpkd1sgv0000uy4xzw6r90wi" |
| lineNumber | int | Number representing the index of the line item within it's credit memo | 1 |
| quantity | float? | Quantity of the credit memo item | 2.0 |
| unitPriceFloat | float? | Unit price of the credit memo item | 50.0 |
| unitsOfMeasure | string? | Unit of measurement for the credit memo item | "EA" |
| invoiceItem | InvoiceItem | The associated invoice item | See Invoice Item docs |
| creditMemo | CreditMemo | The associated credit memo | See CreditMemo |