Query agreed deposits of line item

get https://api.nbx-stage-westeurope.nitrobox.io/v2/orders/{orderIdent}/lineItems/{lineItemIdent}/agreedDeposits

Search for agreed deposits.

Responses

Response body

object

page

object

Meta data about the current page and query.

size

int32

Size of the page as specified by the query.

number

int32

Page number of total pages available.

totalElements

int64

Total count of all elements available for the query.

totalPages

int32

Total count of all pages available for the query.

_embedded

array of objects

Result list.

_embedded

object

name

string

Human readable name, could be printed on document template

grossValue

object

required

Monetary value of the agreed deposit.
A monetary amount along with a currency.

netValue

object

Monetary net value of the agreed deposit.
A monetary amount along with a currency.

taxValue

object

Monetary tax value sum of all tax information of the agreed deposit.
A monetary amount along with a currency.

taxInformation

array of objects

length between 0 and 1

All tax information for this agreed deposit.
Size must be between 0 and 1.

taxInformation

object

taxRate

number

required

≥ 0

Tax rate.
Must not be null.
Must be greater than or equal to 0.

taxCode

string

Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.

taxValue

object

Tax amount for one agreed deposit.
A monetary amount along with a currency.

properties

array of objects

Additional agreed deposit properties

properties

object

propertyIdent

string

required

Key of the property.
Must not be blank.

propertyValue

string

required

Value of the property.
Must not be null.

ident

string

required

length between 1 and 100

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

debitCreditIndicator

string

Item type

DEBIT CREDIT

status

string

Status of the agreed deposit

EXPECTED PAID

source

string

Source of the agreed deposit. Can be line item or order.
Must be one of:

ORDER

LINE_ITEM

createdAt

date-time

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

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/orders/orderIdent/lineItems/lineItemIdent/agreedDeposits?page=0&size=20&sort=' \
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