HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create credit memo

post
https://api.instellix.io/v2/documents/credit-memos

Submit a new document of type credit memo.

Body Params

Creates a document of type credit memo.

string
required
length ≥ 1

The billingGroupIdent of the document. Must be an existing billing group configured for external billing. See Billing Group API.
Must not be blank.

string
required

The currency of the document. The same currency is used for all monetary values in this document.
Three-letter currency code in ISO 4217 standard. See Wikipedia.
Must not be null.

customerDetail
required

Provides information about the customer.

string | null

A note that can be set at document creation, e.g., credit note reason.
Size must be between 0 and 255.

date | null

The date of the document. If not set the current UTC date will be used.

string | null

Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.

items
array of objects
required
length between 1 and 100

A list of items included in the document.
Must not be null.
Size must be between 1 and 100.

items*

An item which belongs to the document

string | null

The SKU/article number.

billingPeriod
object | null

Billing period.

string
required

Category of the item.
Must not be null.
Must be one of:

DIGITAL_PRODUCT
DIGITAL_PRODUCT_RENTAL
DISCOUNT
ELECTRICITY
ELECTRICITY_RESALE
LABOR_COST
LOGISTIC_COST
PHYSICAL_PRODUCT
PHYSICAL_PRODUCT_RENTAL
SERVICE
VOUCHER
VOUCHER_APPLICATION
string | null

The document item's description.

extras
array of objects | null

Document item extras. This are elements that can reduce the value of this item.
For example an item with 100 Euro original gross value is reduced by an item extra (10% voucher for this item) to 90 euro total gross value.

extras
string
required
length between 1 and 100
[a-zA-Z0-9_.~-]{1,100}

Must be a unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string | null

The group to which an item belongs.
Size must be between 0 and 64.

string | null

Name of the document item.

performanceLocation
object
required

Place of service provision of this item.

priceCalculationBasis
array | null

Base price calculation basis for a document item. Per Item only one type of priceCalculationBasis is allowed.

priceCalculationBasis
prices
object
required

Group of prices

  • unit: prices for a single unit of this item,
  • originalTotal: prices for quantity units of this item without application of item.extras,
  • total: prices for quantity units of this item with application of item.extras
properties
array of objects | null

Document item properties

properties
number
required
≥ 0

The count of items.
Must not be null.
Must be greater than or equal to 0.
Must be a number with up to 15 integral digits and up to 4 fractional digits.

string
required

Type of quantity.
Must not be null.
Must be one of:

PC
KWH
SECOND
MINUTE
HOUR
DAY
WEEK
MONTH
YEAR
string | null

Reference ident for this item

string | null

Decides whether this item is refundable or not. Is only applied if the category == VOUCHER or VOUCHER_APPLICATION.
Must be one of:

REFUNDABLE
NON_REFUNDABLE
servicePeriod
object | null

Service period.

taxDetail
object
required

Tax information on item level.

taxLocation
object | null

Place of taxation of this item. If empty the mandatory performanceLocation is used. Country and region must be identical for all items.

string
required

Preferred language for customer interactions (e.g. PDFs, email...).
Two- or three-letter language code in ISO 639-1 standard. See Wikipedia.
Must not be null.

string | null
[a-zA-Z0-9_.~-]{1,100}

Ident of the operating site for the document.
If omitted, the default operating site is used.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

date | null

The date of the order.

paymentInformation
object | null

The payment information for the document.

paymentTerm
object | null

Contains information about the payment term for this document.

postTaxItems
array of objects | null

Document post tax items

postTaxItems
properties
array of objects | null

Document properties.

properties
references
array of objects | null

Document references. If not set: the items[].referenceIdent are collected and used as references.

references
string
required

The identifier which relates to the related document. Mandatory for documents that relates to others.
Examples:

  • An invoice that relates to a deposit invoice
  • A credit memo that relates to an invoice

Must not be null.

string
required
length ≤ 255

Unique identifier of the creation request.
Creation will be aborted if this requestId already exists.
If not sent, no validation will be performed.
Must not be blank.
Size must be between 0 and 255.

string | null
[a-zA-Z0-9_.~-]{1,100}

Ident of the seller operating site for the document.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string
required

The sub-type of this credit memo.
Must not be null.
Must be one of:

DEFAULT
GOODWILL
WARRANTY
Responses
202

The request has been accepted for processing, but the processing has not been completed.

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?