Retrieve credit memo

get https://api.nbx-stage-westeurope.nitrobox.io/v2/documents/credit-memos/{documentIdent}

Get a document of type credit memo by it's ident.

Responses

Response body

object

requestId

string

required

length between 0 and 255

Unique identifier of the creation request.
Size must be between 0 and 255.

ident

string

required

Unique document reference a.k.a. document number.
Must not be null.

billingGroupIdent

string

required

The billingGroupIdent of the document.

customerDetail

object

required

Detailed information of the customer.

customerIdent

string

required

Ident of the customer for the document.
Must not be blank.

debtorAccountNumber

string | null

required

Debtor account number.

invoiceAddress

object

required

The AddressDto contains all Information required for the header of the document. Is used either as recipient of the document or as recipient of the shipped goods.

shippingAddress

object

The AddressDto contains all Information required for the header of the document. Is used either as recipient of the document or as recipient of the shipped goods.

type

string

required

The type of the document.
Must not be null.
Must be one of:

INVOICE

CREDIT_MEMO

CREDIT_MEMO_GOODWILL

CREDIT_MEMO_WARRANTY

DEPOSIT_INVOICE

DEPOSIT_INVOICE_CORRECTION

SELF_BILLING_INVOICE

SELF_BILLING_INVOICE_CORRECTION

dunningLevel

string

required

Dunning level of the document.
Must not be null.
Must be one of:

COMPLETED

WITHIN_PAYMENT_TERM

DUNNING_LEVEL_1

DUNNING_LEVEL_2

DUNNING_LEVEL_3

DUNNING_LEVEL_4

nextDunningLevelDate

date-time

required

The UTC date-time of the next status for dunning process.
ISO 8601 date-time with an offset from UTC/Greenwich (YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss+hh:mm)

dueDate

date

required

The due date of the document.
Must not be null.
ISO 8601 date (YYYY-MM-DD)

documentDate

date

required

The date of the document.
Must not be null.
ISO 8601 date (YYYY-MM-DD)

orderDate

date

required

The date of the order.

language

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.

paymentInformation

object

required

The payment information for the document.

provider

string

The provider that handles the payment.
Must be one of:

ADYEN

AMAZONPAY

COMPUTOP

CONTOWORKS

FIRSTDATATELECASH

GOCARDLESS

GOOGLEPAY

KLARNA

MOLLIE

OPTILE

PAYONE

PAYPAL

RATEPAY

STRIPE

VWFS_SMARTPAY

WORLDLINE

method

string

Payment method associated with the customerPaymentAccount via the paymentReference.

The specification is only for further explanation and has no effect on the actual selection of the payment method.

This is determined entirely by specifying the paymentReference or additionally by the paymentReference.
Must be one of:

ACH

ALIPAY

AMAZONPAY

APPLE_PAY

BANKTRANSFER

CREDIT_CARD

DIRECT_DEBIT

GOOGLEPAY

IDEAL

KLARNA

KLARNA_INSTALLMENT

KLARNA_PAY_LATER

PAYPAL

PAYU

PURCHASE_ORDER

RATEPAY

SOFORT

UNION_PAY

WECHAT

WIRE_TRANSFER

YANDEX

OTHER

paymentReference

string

length between 0 and 255

Payment reference on the account statement (e.g. invoice number).
Size must be between 0 and 255.

cardType

string

The type of credit card you can choose. Only used, when payment method is "CREDIT_CARD".
Must be one of:

AMERICANEXPRESS

CARTE_BANCAIRE

DINERSCLUB

DISCOVERCARD

JCB

MASTERCARD

VISA

YANDEXBANKCARD

OTHER

displayName

string

length between 0 and 255

Name for the customer payment account displayed on invoices (e.g. "** ** ** 234").

Do not send full payment data like credit card no, IBAN, etc.!.
Size must be between 0 and 255.

currency

string

required

The document's currency.
Three-letter currency code in ISO 4217 standard. See Wikipedia.
Must not be null.

serviceCountry

string

required

The country where the document will be billed.
Two- or three-letter language code in ISO 3166-1 standard. See Wikipedia.
Must not be null.

documentTotals

object

required

Aggregation of all values of this document.
originalTotalNetSum + originalTotalTax = originalTotalGrossSum
totalNetSum + totalTaxSum = totalGrossSum
totalGrossSum +/- totalPostTaxSum = totalDocumentAccountDue (+/- depends on document type)
totalDocumentAccountDue +/- totalDepositSum = totalDue (+/- depends on document type)

originalTotalNetSum

number

Sum of all item line net amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalTaxSum

number

Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalGrossSum

number

Sum of all item line gross amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalNetSum

number

required

Sum of all item line net amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalTaxSum

number

required

Sum of all item line tax amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalGrossSum

number

required

Sum of all item line gross amounts with line allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalPostTaxSum

number

required

Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDocumentAccountDue

number

required

Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDepositSum

number

required

Sum of all deposits. Is always negative.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDue

number

required

Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras) and deposits. This is the amount expected to actually be paid.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

operatingSite

object

required

Operating site information used for this document.

ident

string

required

length between 1 and 100

Identifier of the operating site. It is unique per tenant.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

type

string

required

Type of the operating site.
Must be one of:

HEADQUARTERS

NON_SELF_SUSTAINING_SUBSIDIARY

name

string

required

Company name is the name of a company which must be entered in the commercial register.
Must not be blank.

addressAddition

string

Optional additional address information that helps to identify the exact location.

street

string

Street of the operating site.

streetNumber

string

Street number of the operating site.

postOfficeBox

string

Number of the post office box from operating site.

postalCode

string

Postcode where the operating site is located.

city

string

City where the operating site is located.

state

string

State where the operating site is located.

stateCode

string

State code where the operating site is located.

country

string

required

Country code for the country code where the operating site is registered.
Two- or three-letter language code in ISO 3166-1 standard. See Wikipedia.
Must not be null.

phoneNumber

string

The phone number to get in touch with the operating site.

string

Email that is used to contact the operating site.

vatId

string

VatId of the registered operating site.

taxNumber

string

Tax number of the registered operating site.

bankAccount

object

Bank account data of the operating site used for this document.

tenantRegistration

object

Official registration information of the tenant.

directors

array of strings

List of directors of the operating site.

directors

safT

object

required

Is an international standard for electronic exchange of reliable accounting data from organizations to a national tax authority or external auditors.
Saf-T Reports might differ from service country per document.

safTCountry

string

required

Describes for which service country of the document the saf-t rules are applied. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.
Must not be blank.

documentSeries

string

required

Identifier of the document series that was requested and approved beforehand by the tax authority.
Must not be blank.

documentTypeInternalCode

string

required

Identifier of the document type. Obtained beforehand by the tax authority.
Must not be blank.

hash

string

required

Signature of a document that is created based on several parameters using RSA-SHA1.
Must not be blank.

publicKeyVersion

string

required

Version of the asymmetric public key to identify which key has to be used to decrypt the hash.
Must not be blank.

certificationNumber

string

required

Certification number allocated to the invoicing system.
Must not be blank.

atcud

string

required

Unique document code that will need to be part of invoices in Portugal from 2022, and is separate from the internal taxpayer invoice number.
Must not be blank.

qrCode

string

required

Data for a QRCode which contains all the data about a particular invoice coded in line with technical requirements provided by tax authorities.
Must not be blank.

sequenceNumber

int64

required

Sequence number of the invoice.
Must not be null.

relatedDocumentIdent

string

required

The identifier of the related document.

preferredDocumentDelivery

string

required

The method by which the document should be delivered.
Must be one of:

LETTER

NONE

paymentCollection

object

required

Contains information about the payment collection for this document.

customerPaymentAccountIdent

string

Valid customer payment account ident, required for automatic payment collection by NBX. Mandatory when paymentControl is set to CHARGE.

paymentControl

string

required

If paymentControl is set to CHARGE, the automatic payment collection by NBX is enabled. In this case, a valid customerPaymentAccountIdent must be provided.
Must not be null.
Must be one of:

CHARGE

NOCHARGE

paymentTerm

object

required

Contains information about the payment term for this document.

periodInDays

int32

required

Payment term period in days.
Must be greater than or equal to 0.

oposCaseIdent

string

required

Ident of the OposCase related to this document. The OposCase handles the open position management of related document and payments.

vatIdValidationResult

object

Result of the VatId validation for this customer.

ident

string

required

length between 1 and 100

Unique identifier of this VatId validation.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

vatId

string

required

VatId used for the validation.

validatedAt

date-time

required

Technical request date and time of the VatId validation.
Must not be null.
ISO 8601 date-time with an offset from UTC/Greenwich (YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss+hh:mm)

status

string

required

Mapped status of the validation response.
Must not be null.
Must be one of:

VALID

INVALID

FAILED

NONE

validationProvider

string

required

Service used to validate the VatId.
Must not be blank.

references

array of objects

required

The distinct references of the document's items.
Must not be null.

references*

object

ident

string

required

Reference identifier for this document.
Must not be blank.

type

string

required

Reference type for this document.
Must not be null.
Must be one of:

CONTRACT

ORDER

INVOICE

EXTERNAL

labels

array of objects

required

List of labels assigned to this document.
Must not be null.

labels*

object

ident

string

Unique external reference and name of the Label

items

array of objects

required

Document items.
Must not be empty.

items*

object

ident

string

required

length between 1 and 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}'.

reference

object

required

Reference ident and type for this item

articleNumber

string

The SKU/article number.

name

string

Name of the document item.

description

string

The document item's description.

quantity

number

required

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.

quantityType

string

required

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

KWH

SECOND

MINUTE

HOUR

DAY

WEEK

MONTH

YEAR

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

lineItemType

string

required

Line item type of the document item. Determines if this item was a service rendered to your customer (SALES) or by your customer (SELF-BILLING).
Must not be null.
Must be one of:

SALES

SELF_BILLING

category

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

servicePeriod

object

Service period.

refundabilityType

string

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

itemGroup

string

length between 0 and 64

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

taxDetail

object

required

Tax information on item level.

taxLocation

object

Place of taxation of this item.

performanceLocation

object

required

Place of service provision of this item.

extras

array of objects

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

object

ident

string

required

length between 1 and 100

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

type

string

required

Type of the extra.
Must not be null.
Must be one of:

VOUCHER

DISCOUNT

SINGLE_PURPOSE_VOUCHER

externalReference

string

Additional external reference.

name

string

Name of the extra.

price

object

required

Group of prices

unitPrice: all prices for a single quantity of this item,
originalRowTotal: all prices for all quanitities of this item without application of item.extras,
rowTotal: all prices for all quanitities of this item with application of item.extras

Always deliver positive amounts. NBX will take care if it is a DEBIT or CREDIT amount.

taxDetail

object

required

Tax detail of item extra

refundabilityType

string

required

Decides whether this extra item is refundable or not.
Must not be null.
Must be one of:

REFUNDABLE

NON_REFUNDABLE

properties

array of objects

Document item extra properties.

properties

object

key

string

required

length between 0 and 255

Key of the property.
Must not be blank.
Size must be between 0 and 255.

value

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

properties

array of objects

Document item properties

properties

object

key

string

required

length between 0 and 255

Key of the property.
Must not be blank.
Size must be between 0 and 255.

value

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

billingPeriod

object

Billing period.

postTaxItems

array of objects

required

Document post tax items.

postTaxItems*

object

ident

string

required

length between 1 and 100

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

type

string

required

Type of the post tax extra.
Must not be null.
Must be one of:

MULTI_PURPOSE_VOUCHER

name

string

Name of the post tax extra.

price

number

required

Price of the post tax extra.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

externalReference

string

Additional reference for third party system.

description

string

Description of this post tax item.

refundabilityType

string

required

Decides whether this extra item is refundable or not.
Must not be null.
Must be one of:

REFUNDABLE

NON_REFUNDABLE

properties

array of objects

Document item post tax extra properties.

properties

object

key

string

required

length between 0 and 255

Key of the property.
Must not be blank.
Size must be between 0 and 255.

value

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

subTotalSums

array of objects

required

deprecated

DEPRECATED: Please use "Retrieve document aggregations" endpoint.

Will be sunset latest on 2026-07-22.

Totals from configured predefined document aggregations.
Must not be null.

subTotalSums*

object

originalTotalNetSum

number

Sum of all item line net amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalTaxSum

number

Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalGrossSum

number

Sum of all item line gross amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalNetSum

number

required

Sum of all item line net amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalTaxSum

number

required

Sum of all item line tax amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalGrossSum

number

required

totalPostTaxSum

number

required

Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDocumentAccountDue

number

required

Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDepositSum

number

required

Sum of all deposits. Is always negative.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDue

number

required

groupingFieldName

string

Name of the grouping.

groupingFieldValue

string

First level value of the grouping.

groupingFieldSubValue

string

Optional second level value of the grouping.

customSubTotalSums

array of objects

required

deprecated

DEPRECATED: Please use "Retrieve document aggregations" endpoint.

Will be sunset latest on 2026-07-22.

Totals from configured custom document aggregations.
Must not be null.

customSubTotalSums*

object

originalTotalNetSum

number

Sum of all item line net amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalTaxSum

number

Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalGrossSum

number

Sum of all item line gross amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalNetSum

number

required

Sum of all item line net amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalTaxSum

number

required

Sum of all item line tax amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalGrossSum

number

required

totalPostTaxSum

number

required

Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDocumentAccountDue

number

required

Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDepositSum

number

required

Sum of all deposits. Is always negative.
Must not be null.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalDue

number

required

groupingFieldName

string

Name of the grouping.

groupingFieldValue

string

First level value of the grouping.

groupingFieldSubValue

string

Optional second level value of the grouping.

properties

array of objects

required

Document properties.

properties*

object

key

string

required

length between 0 and 255

Key of the property.
Must not be blank.
Size must be between 0 and 255.

value

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

createdAt

date-time

required

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

lastModifiedAt

date-time

required

Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.nbx-stage-westeurope.nitrobox.io/v2/documents/credit-memos/documentIdent \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX