PUT v1/CreditNotes
Update a list of Credit Notes.
Request Information
URI Parameters
None.
Body Parameters
Collection of CreditNoteName | Description | Type | Additional information |
---|---|---|---|
Status |
Status (Read-only) |
OrderStatus |
None. |
MemberEmail |
The CRM contact email of a customer. |
string |
Max length: 250 |
SalesReference |
The Sales Order reference. |
string |
Required Max length: 50 |
CreditNoteNumber |
Credit note number (Read-only) |
integer |
None. |
CreditNoteDate |
Credit Note Date. Send to 3rd party accounting system no earlier than this date. |
date |
None. |
CompletedDate |
Completed Date. |
date |
None. |
CustomerReport |
Notes to customer e.g. the reason for issuing a Credit Note. |
string |
None. |
AlternativeAccountCode |
Alternative GL Account Code. |
string |
None. |
SalesPersonId |
The unique Cin7 user Id of the sales person. |
integer |
None. |
LogisticsCarrier |
Logistics Carrier |
string |
None. |
LogisticsStatus |
Logistics Status |
integer |
None. |
LineItems |
Line Items |
Collection of CreditNoteItem |
None. |
AccountingAttributes |
This is for the Accounting Attributes |
AccountingAttributes |
None. |
ModifiedCOGSDate |
Last modified date of Cost of Good Sold(COGS) - (Read-only) |
date |
None. |
Id |
The unique Cin7 Id. |
integer |
None. |
CreatedDate |
Created date. |
date |
None. |
ModifiedDate |
Last modified date. |
date |
None. |
CreatedBy |
The ID for the User who created the Transaction. |
integer |
None. |
ProcessedBy |
The ID for the User who processed the Transaction. |
integer |
None. |
IsApproved |
Is Approved (default: true) |
boolean |
None. |
Reference |
A unique order reference (leave blank to auto-generate in an insert). |
string |
Max length: 30 |
MemberId |
The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order. |
integer |
None. |
FirstName |
Contact first name |
string |
Max length: 250 |
LastName |
Contact last name |
string |
Max length: 250 |
Company |
Contact company |
string |
Max length: 250 |
Contact email address, could be different from MemberEmail assigned to the order |
string |
Max length: 250 |
|
Phone |
Contact phone |
string |
Max length: 50 |
Mobile |
Contact mobile |
string |
Max length: 50 |
Fax |
Contact fax |
string |
Max length: 50 |
DeliveryFirstName |
Delivery recipient first name |
string |
Max length: 250 |
DeliveryLastName |
Delivery recipient last name |
string |
Max length: 250 |
DeliveryCompany |
Delivery recipient company name |
string |
Max length: 250 |
DeliveryAddress1 |
Delivery address 1 |
string |
Max length: 250 |
DeliveryAddress2 |
Delivery address 2 |
string |
Max length: 250 |
DeliveryCity |
Delivery address city |
string |
Max length: 250 |
DeliveryState |
Delivery address state |
string |
Max length: 250 |
DeliveryPostalCode |
Delivery address postcode |
string |
Max length: 250 |
DeliveryCountry |
Delivery address country |
string |
Max length: 250 |
BillingFirstName |
Billing recipient first name |
string |
Max length: 250 |
BillingLastName |
Billing recipient last name |
string |
Max length: 250 |
BillingCompany |
The billing company name |
string |
Max length: 250 |
BillingAddress1 |
Billing address 1 |
string |
Max length: 250 |
BillingAddress2 |
Billing address 2 |
string |
Max length: 250 |
BillingCity |
Billing address city |
string |
Max length: 250 |
BillingPostalCode |
Billing address postcode |
string |
Max length: 250 |
BillingState |
Billing address state |
string |
Max length: 250 |
BillingCountry |
Billing address country |
string |
Max length: 250 |
BranchId |
Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to "Main Branch" ID when omitted. |
integer |
None. |
BranchEmail |
Branch email |
string |
Max length: 250 |
ProjectName |
Project Name |
string |
None. |
TrackingCode |
Shipping tracking code |
string |
Max length: 50 |
InternalComments |
Internal comment |
string |
None. |
ProductTotal |
Product Total Only |
decimal number |
None. |
FreightTotal |
Total cost of delivery charges |
decimal number |
None. |
FreightDescription |
Freight/carrier description |
string |
None. |
Surcharge |
Surcharge |
decimal number |
None. |
SurchargeDescription |
Surcharge description |
string |
None. |
DiscountTotal |
Total overall discount |
decimal number |
None. |
DiscountDescription |
The discount description |
string |
None. |
Total |
Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax |
decimal number |
None. |
CurrencyCode |
The three-character ISO currency code e.g. NZD. Omit to use account default. |
string |
None. |
CurrencyRate |
The currency rate. If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service. |
decimal number |
None. |
CurrencySymbol |
The currency symbol e.g. $. This field is automatically populate based on currency code. |
string |
None. |
TaxStatus |
Tax Status: Incl, Excl, Exempt. Omit to use account default. |
TaxStatus |
None. |
TaxRate |
Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well. |
decimal number |
Range: inclusive between 0 and 100 |
Source |
The source of the Transaction. This field is read-only. |
string |
None. |
CustomFields |
Custom fields. |
Dictionary of string [key] and Object [value] |
None. |
Request Formats
application/json, text/json
[ { "id": 8, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "modifiedDate": "2024-11-18T22:11:30.8111921+13:00", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2024-11-18T22:11:30.8111921+13:00", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2024-11-18T22:11:30.8111921+13:00", "completedDate": "2024-11-18T22:11:30.8111921+13:00", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2024-11-18T22:11:30.8111921+13:00", "accountingImportStatus": "NotImported" } }, { "id": 8, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "modifiedDate": "2024-11-18T22:11:30.8111921+13:00", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2024-11-18T22:11:30.8111921+13:00", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2024-11-18T22:11:30.8111921+13:00", "completedDate": "2024-11-18T22:11:30.8111921+13:00", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2024-11-18T22:11:30.8111921+13:00", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2024-11-18T22:11:30.8111921+13:00", "accountingImportStatus": "NotImported" } } ]
Response Information
Resource Description
Collection of BatchResultItemName | Description | Type | Additional information |
---|---|---|---|
Index |
The index at which the record was positioned in an insert or update. |
integer |
None. |
Success |
True if the record was successfully inserted or updated. |
boolean |
None. |
Id |
The record Id. |
integer |
None. |
Code |
The record code. |
string |
None. |
Errors |
A list of errors if the insert or update fails. |
Collection of string |
None. |
Response Formats
application/json, text/json
[ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ]