POST v1/CreditNotes

Create a list of Credit Notes.

Request Information

URI Parameters

None.

Body Parameters

Collection of CreditNote
NameDescriptionTypeAdditional information
Status

Status (Readonly)

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 (Readonly)

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.

LineItems

Collection of CreditNoteItem

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

Email

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.

string

None.

CustomFields

Custom fields.

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "id": 6,
    "createdDate": "2020-10-21T02:45:42.6557902+13:00",
    "modifiedDate": "2020-10-21T02:45:42.6557902+13:00",
    "createdBy": 7,
    "processedBy": 8,
    "isApproved": true,
    "reference": "sample string 10",
    "memberId": 11,
    "firstName": "sample string 12",
    "lastName": "sample string 13",
    "company": "sample string 14",
    "email": "sample string 15",
    "phone": "sample string 16",
    "mobile": "sample string 17",
    "fax": "sample string 18",
    "deliveryFirstName": "sample string 19",
    "deliveryLastName": "sample string 20",
    "deliveryCompany": "sample string 21",
    "deliveryAddress1": "sample string 22",
    "deliveryAddress2": "sample string 23",
    "deliveryCity": "sample string 24",
    "deliveryState": "sample string 25",
    "deliveryPostalCode": "sample string 26",
    "deliveryCountry": "sample string 27",
    "billingFirstName": "sample string 28",
    "billingLastName": "sample string 29",
    "billingCompany": "sample string 30",
    "billingAddress1": "sample string 31",
    "billingAddress2": "sample string 32",
    "billingCity": "sample string 33",
    "billingPostalCode": "sample string 34",
    "billingState": "sample string 35",
    "billingCountry": "sample string 36",
    "branchId": 37,
    "branchEmail": "sample string 38",
    "projectName": "sample string 39",
    "trackingCode": "sample string 40",
    "internalComments": "sample string 41",
    "productTotal": 42.0,
    "freightTotal": 1.0,
    "freightDescription": "sample string 43",
    "surcharge": 1.0,
    "surchargeDescription": "sample string 44",
    "discountTotal": 1.0,
    "discountDescription": "sample string 45",
    "total": 46.0,
    "currencyCode": "sample string 48",
    "currencyRate": 49.0,
    "currencySymbol": "sample string 50",
    "taxStatus": "Undefined",
    "taxRate": 51.0,
    "source": "sample string 52",
    "customFields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "memberEmail": "sample string 1",
    "status": "DRAFT",
    "salesReference": "sample string 2",
    "creditNoteNumber": 3,
    "creditNoteDate": "2020-10-21T02:45:42.6557902+13:00",
    "completedDate": "2020-10-21T02:45:42.6557902+13:00",
    "customerReport": "sample string 4",
    "alternativeAccountCode": "sample string 5",
    "lineItems": [
      {
        "id": 9,
        "createdDate": "2020-10-21T02:45:42.6557902+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": 21.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": "2020-10-21T02:45:42.6557902+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": 21.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": 6,
    "createdDate": "2020-10-21T02:45:42.6557902+13:00",
    "modifiedDate": "2020-10-21T02:45:42.6557902+13:00",
    "createdBy": 7,
    "processedBy": 8,
    "isApproved": true,
    "reference": "sample string 10",
    "memberId": 11,
    "firstName": "sample string 12",
    "lastName": "sample string 13",
    "company": "sample string 14",
    "email": "sample string 15",
    "phone": "sample string 16",
    "mobile": "sample string 17",
    "fax": "sample string 18",
    "deliveryFirstName": "sample string 19",
    "deliveryLastName": "sample string 20",
    "deliveryCompany": "sample string 21",
    "deliveryAddress1": "sample string 22",
    "deliveryAddress2": "sample string 23",
    "deliveryCity": "sample string 24",
    "deliveryState": "sample string 25",
    "deliveryPostalCode": "sample string 26",
    "deliveryCountry": "sample string 27",
    "billingFirstName": "sample string 28",
    "billingLastName": "sample string 29",
    "billingCompany": "sample string 30",
    "billingAddress1": "sample string 31",
    "billingAddress2": "sample string 32",
    "billingCity": "sample string 33",
    "billingPostalCode": "sample string 34",
    "billingState": "sample string 35",
    "billingCountry": "sample string 36",
    "branchId": 37,
    "branchEmail": "sample string 38",
    "projectName": "sample string 39",
    "trackingCode": "sample string 40",
    "internalComments": "sample string 41",
    "productTotal": 42.0,
    "freightTotal": 1.0,
    "freightDescription": "sample string 43",
    "surcharge": 1.0,
    "surchargeDescription": "sample string 44",
    "discountTotal": 1.0,
    "discountDescription": "sample string 45",
    "total": 46.0,
    "currencyCode": "sample string 48",
    "currencyRate": 49.0,
    "currencySymbol": "sample string 50",
    "taxStatus": "Undefined",
    "taxRate": 51.0,
    "source": "sample string 52",
    "customFields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "memberEmail": "sample string 1",
    "status": "DRAFT",
    "salesReference": "sample string 2",
    "creditNoteNumber": 3,
    "creditNoteDate": "2020-10-21T02:45:42.6557902+13:00",
    "completedDate": "2020-10-21T02:45:42.6557902+13:00",
    "customerReport": "sample string 4",
    "alternativeAccountCode": "sample string 5",
    "lineItems": [
      {
        "id": 9,
        "createdDate": "2020-10-21T02:45:42.6557902+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": 21.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": "2020-10-21T02:45:42.6557902+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": 21.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"
      }
    ]
  }
]

Response Information

Resource Description

Collection of BatchResultItem
NameDescriptionTypeAdditional 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

Sample:
[
  {
    "index": 0,
    "success": true,
    "id": 1,
    "code": "SALE4-28",
    "errors": []
  },
  {
    "index": 1,
    "success": true,
    "id": 2,
    "code": "SALE5-29",
    "errors": []
  }
]