vivenu credit-notes API
The credit-notes API from vivenu — 2 operation(s) for credit-notes.
OpenAPI Specification
openapi: 3.0.3
info:
title: vivenu access-lists credit-notes API
description: vivenu API Documentation
version: 1.0.0
contact:
name: vivenu GmbH
url: https://vivenu.com
servers:
- url: https://vivenu.com
description: Production API
- url: https://vivenu.dev
description: Staging API
tags:
- name: credit-notes
paths:
/api/credit-notes:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: transactionId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: offerId
schema:
type: string
in: query
required: false
style: form
explode: true
- name: top
schema:
default: 25
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
type: integer
minimum: 1
maximum: 1000
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
in: query
required: false
style: form
explode: true
- name: skip
schema:
default: 0
description: The number of objects to skip for the requested result
type: integer
minimum: 0
maximum: 9007199254740991
description: The number of objects to skip for the requested result
in: query
required: false
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Credit-notes_ListCreditNotes_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- credit-notes
description: List Credit Notes
operationId: credit-notes/list
/api/public/credit-notes/{id}/info:
get:
parameters:
- name: secret
schema:
type: string
in: query
required: true
style: form
explode: true
- name: id
schema:
type: string
required: true
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Credit-notes_GetCreditNoteInfo_200_response'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- credit-notes
description: Get Credit Note Info
operationId: credit-notes/info
components:
schemas:
CustomerResource:
type: object
properties:
_id:
type: string
description: The ID of the customer
company:
type: string
nullable: true
description: The company of the customer
name:
type: string
nullable: true
description: The name of the customer collected from first name and last name
prename:
type: string
nullable: true
description: The first name of the customer
lastname:
type: string
nullable: true
description: The lastname of the customer
image:
type: string
nullable: true
description: The image of the customer
deprecated: true
primaryEmail:
type: string
format: email
description: The primary email of the customer
number:
type: number
format: float
description: The number of the customer. Need to be unique and incrementing
phone:
type: string
description: The phone number of the customer
location:
type: object
properties:
street:
type: string
nullable: true
description: The street of the location
line2:
type: string
nullable: true
description: The additional address fields of the location
postal:
type: string
nullable: true
description: The postal of the location
city:
type: string
nullable: true
description: The city of the location
locale:
type: string
nullable: true
description: The locale of the location
deprecated: true
state:
type: string
nullable: true
description: The state of the location
center:
type: array
items:
type: number
format: float
nullable: true
description: The center of the location
deprecated: true
country:
type: string
nullable: true
description: An ISO-3166-1 Alpha 2 country code of the location
description: The location of the customer
sellerId:
type: string
description: The ID of the seller of the customer
notes:
type: string
nullable: true
description: Notes of the customer
extraFields:
type: object
nullable: true
description: Extra fields of the customer
tags:
type: array
items:
type: string
description: An array of tags
segments:
type: array
items:
type: string
description: An array of segment slugs, read only
blocked:
type: boolean
description: Whether the customer is blocked
verified:
type: boolean
description: Whether the customer is verified
identification:
type: array
items:
$ref: '#/components/schemas/LegalIdentificationDocumentResource'
description: An array of identification items
_account:
type: object
properties:
verificationToken:
type: string
description: The verification token will be sent to the customer via email within a verification link, which can be used to verify the account of the customer
passwordResetToken:
type: string
description: The password reset token will be sent within a password reset link via email, which can be used by the customer to reset its password
limitations:
type: object
properties:
nextVerificationMailRequest:
type: string
format: date-time
description: An ISO timestamp indicating when the next verification mail request can be sent
description: Account specific limitations of the customer
loginType:
type: string
nullable: true
enum:
- password
- identityprovider
description: The login type of the customer.
description: Account specific information about the customer
meta:
type: object
description: Custom key-value data. Metadata is useful for storing additional, structured information on an object.
externalId:
type: string
nullable: true
description: An external identifier of the customer
createdAt:
type: string
format: date-time
description: An ISO timestamp indicating when the customer was created
updatedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the customer was updated
required:
- _id
- primaryEmail
description: The associated customer which has been updated
TransactionResource:
type: object
properties:
_id:
type: string
description: The ID of the transaction
sellerId:
type: string
description: The ID of the seller of the transaction
customerId:
type: string
description: The ID of the customer of the transaction
eventId:
type: string
description: The ID of the event containing this transaction
company:
type: string
description: The company name of the user of the transaction
name:
type: string
description: The name of the user of the transaction
prename:
type: string
description: The firstname of the user of the transaction
lastname:
type: string
description: The lastname of the user of the transaction
email:
type: string
format: email
description: The email of the user of the transaction
street:
type: string
description: The street of the user of the transaction
line2:
type: string
description: The additional address field of the user of the transaction.
city:
type: string
description: The city of the user of the transaction
state:
type: string
description: The state of the user of the transaction
country:
type: string
description: The country of the user of the transaction
postal:
type: string
description: The postal of the user of the transaction
deliveryAddress:
type: object
properties:
fullAddress:
type: string
nullable: true
description: Optional full address
street:
type: string
nullable: true
description: The street of the address. Street name including number.
line2:
type: string
nullable: true
description: The additional field of the address.
postal:
type: string
nullable: true
description: The postal code of the address.
city:
type: string
nullable: true
description: The city of the address.
country:
type: string
nullable: true
description: The country of the address. An ISO 3166 country code.
state:
type: string
nullable: true
description: The state of the address. If applicable
name:
type: string
description: The name of the person receiving delivery.
description: The delivery address of the transaction
identification:
type: array
items:
$ref: '#/components/schemas/LegalIdentificationDocumentResource'
description: An array of identification items
tickets:
type: array
items:
type: object
properties:
type:
type: string
enum:
- ticket
description: The type of the cart item.
default: ticket
_id:
type: string
description: Unique identifier for the cart item. If omitted, the system will automatically generate one.
name:
type: string
nullable: true
description: The name of the cart item.
amount:
type: integer
minimum: 1
description: The amount of the cart item.
netPrice:
type: number
format: float
description: The single piece net price of the cart item.
price:
type: number
format: float
description: The single piece price of the cart item.
taxRate:
type: number
format: float
nullable: true
description: The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.
triggeredBy:
oneOf:
- type: string
description: An ID of another cart item which triggered the buy action of the cart item.
- type: array
items:
type: string
description: An array of IDs of other cart items which triggered the buy action of the cart item.
nullable: true
description: An ID or an array of IDs of other cart items which triggered the buy action of the cart item.
bundleInfo:
type: object
properties:
bundleId:
type: string
componentId:
type: string
optionId:
type: string
nullable: true
ticketTypeId:
type: string
description: The ID of the ticket type of the cart item.
categoryRef:
type: string
description: The category reference of the ticket type.
seatingInfo:
type: object
properties:
_id:
type: string
description: The ID of the seating object.
_type:
type: number
format: float
enum:
- 6
- 7
description: Indicates the type of seating object. Seat = 6, General Admission = 7.
categoryId:
type: string
description: The ID of the category containing the seating object.
statusId:
type: string
description: The ID of a container holding information about the seating status of the seating object.
name:
type: string
nullable: true
description: If _type == 7. The name of the general admission.
seatType:
type: string
nullable: true
enum:
- handicapped
- limitedView
- foldable
description: If _type == 6. The type of the seat. null = normal.
sectionName:
type: string
nullable: true
description: If _type == 6. The name of the section where the seat is located.
groupName:
type: string
nullable: true
description: If _type == 6. The name of the row group where the seat is located.
rowName:
type: string
nullable: true
description: If _type == 6. The name of the row where the seat is located.
seatName:
type: string
nullable: true
description: If _type == 6. The seat name.
gate:
type: string
nullable: true
description: The entry gate associated with the seating object.
required:
- _type
- statusId
nullable: true
description: The associated seating object.
slotInfo:
type: object
properties:
slotId:
type: string
description: The ID of the time slot.
slotStartTime:
type: string
description: The start time of the time slot.
required:
- slotId
- slotStartTime
nullable: true
description: The associated time slot object.
asHardTicket:
type: boolean
nullable: true
description: Whether this ticket is a hard ticket.
listingId:
type: string
nullable: true
description: Listing in secondary market.
listingItemId:
type: string
nullable: true
description: The ID of the listing item in the secondary market.
triggeredAutomations:
type: boolean
nullable: true
description: Whether the cart item triggered automations.
meta:
type: object
nullable: true
description: Meta data which is propagated to the ticket.
addOns:
type: array
items:
type: object
properties:
productId:
type: string
productVariantId:
type: string
name:
type: string
required:
- productId
- productVariantId
- name
description: A list of Add-Ons of the ticket.
capabilities:
type: array
items:
oneOf:
- type: object
properties:
type:
type: string
enum:
- self_service_return
settings:
type: object
properties:
returnRelatedItems:
type: boolean
default: true
phases:
type: array
items:
type: object
properties:
condition:
type: object
properties:
target:
type: string
nullable: true
description: The target of the relative date
unit:
type: string
enum:
- hours
- days
- weeks
- months
- years
description: The unit in which the offset is specified
offset:
type: integer
description: The offset to the date
required:
- unit
- offset
refundPercentage:
type: number
format: float
minimum: 0
maximum: 1
required:
- condition
- refundPercentage
required:
- phases
required:
- type
- settings
- type: object
properties:
type:
type: string
enum:
- repersonalization
settings:
type: object
properties:
inherit:
type: boolean
repersonalizationDeadline:
type: object
properties:
target:
type: string
nullable: true
description: The target of the relative date
unit:
type: string
enum:
- hours
- days
- weeks
- months
- years
description: The unit in which the offset is specified
offset:
type: integer
description: The offset to the date
required:
- unit
- offset
repersonalizationsLimit:
type: number
format: float
nullable: true
repersonalizationFee:
type: number
format: float
nullable: true
limitOnlyNameChanges:
type: boolean
required:
- repersonalizationDeadline
required:
- type
- settings
nullable: true
description: The capabilities of the ticket.
taxInfo:
type: object
properties:
serviceTypeId:
type: string
description: The ID of the service type.
exceptionId:
type: string
description: The ID of the exception.
proceedsAccountId:
type: string
description: The ID of the proceeds account.
proceedsAccountCode:
type: string
description: The code of the proceeds account.
taxItems:
type: array
items:
type: object
properties:
name:
type: string
nullable: true
taxTypeId:
type: string
nullable: true
rate:
type: number
format: float
perUnit:
type: number
format: float
total:
type: number
format: float
netTotal:
type: number
format: float
nullable: true
netPerUnit:
type: number
format: float
nullable: true
taxPayableAccountId:
type: string
nullable: true
taxPayableAccountCode:
type: string
nullable: true
required:
- rate
- perUnit
- total
description: The array of tax items.
description: The tax info details.
required:
- amount
- price
- ticketTypeId
description: An array of cart ticket items of the transaction
default: []
products:
type: array
items:
type: object
properties:
type:
type: string
enum:
- product
description: The type of the cart item.
_id:
type: string
description: Unique identifier for the cart item. If omitted, the system will automatically generate one.
name:
type: string
nullable: true
description: The name of the cart item.
amount:
type: integer
minimum: 1
description: The amount of the cart item.
netPrice:
type: number
format: float
description: The single piece net price of the cart item.
price:
type: number
format: float
description: The single piece price of the cart item.
taxRate:
type: number
format: float
nullable: true
description: The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.
triggeredBy:
oneOf:
- type: string
description: An ID of another cart item which triggered the buy action of the cart item.
- type: array
items:
type: string
description: An array of IDs of other cart items which triggered the buy action of the cart item.
nullable: true
description: An ID or an array of IDs of other cart items which triggered the buy action of the cart item.
bundleInfo:
type: object
properties:
bundleId:
type: string
componentId:
type: string
optionId:
type: string
nullable: true
productVariantId:
type: string
description: The ID of the product variant.
isFulfillable:
type: boolean
description: Whether the product can be delivered
taxInfo:
type: object
properties:
serviceTypeId:
type: string
description: The ID of the service type.
exceptionId:
type: string
description: The ID of the exception.
proceedsAccountId:
type: string
description: The ID of the proceeds account.
proceedsAccountCode:
type: string
description: The code of the proceeds account.
taxItems:
type: array
items:
type: object
properties:
name:
type: string
nullable: true
taxTypeId:
type: string
nullable: true
rate:
type: number
format: float
perUnit:
type: number
format: float
total:
type: number
format: float
netTotal:
type: number
format: float
nullable: true
netPerUnit:
type: number
format: float
nullable: true
taxPayableAccountId:
type: string
nullable: true
taxPayableAccountCode:
type: string
nullable: true
required:
- rate
- perUnit
- total
description: The array of tax items.
description: The tax info details.
required:
- type
- amount
- price
- productVariantId
description: An array of cart product items of the transaction
default: []
additionalItems:
type: array
items:
oneOf:
- type: object
properties:
itemId:
type: string
description: The ID of the item.
type:
type: string
enum:
- bundle
description: The type of the additional item.
netPrice:
type: number
format: float
description: The single piece net price of the additional item.
price:
type: number
format: float
description: The single piece price of the additional item.
taxRate:
type: number
format: float
nullable: true
description: The tax rate to be applied to this additional item.
taxInfo:
type: object
properties:
serviceTypeId:
type: string
description: The ID of the service type.
exceptionId:
type: string
description: The ID of the exception.
proceedsAccountId:
type: string
description: The ID of the proceeds account.
proceedsAccountCode:
type: string
description: The code of the proceeds account.
taxItems:
type: array
items:
type: object
properties:
name:
type: string
nullable: true
taxTypeId:
type: string
nullable: true
rate:
type: number
format: float
perUnit:
type: number
format: float
total:
type: number
format: float
netTotal:
type: number
format: float
nullable: true
netPerUnit:
type: number
format: float
nullable: true
taxPayableAccountId:
type: string
nullable: true
taxPayableAccountCode:
type: string
nullable: true
required:
- rate
- perUnit
- total
description: The array of tax items.
description: The tax info details.
data:
type: object
properties:
bundleId:
type: string
description: The ID of the bundle.
required:
- bundleId
required:
- itemId
- type
- netPrice
- price
- taxRate
- type: object
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vivenu/refs/heads/main/openapi/vivenu-credit-notes-api-openapi.yml