V3 API
API Version 2024-08-23 (latest)

Create integrations, retrieve data, and automate your workflows with the V3 REST API.

Introduction Action file - Module Shares Addon - Module Subscriptions Area - Module Bookings Core Beneficiary - Module Subscriptions Blocking - Module Bookings Core Booking - Module Bookings Core Booking type - Module Bookings Core Client Archives - Module Customers Comment - Module Tasks Company - Module Core Sales Contact - Module CRM Courses - Module School Customer - Module Customers Customer tag - Module Customers Detailed charges - Module Core Sales Documentation - Module Documentation Dynamic price - Module Dynamic prices Dynamic price tag - Module Dynamic prices Help article - Module Help (Server) Invoice - Module Invoicing Invoice payment - Module Invoicing Invoice series - Module Invoicing Line Q19 - Module SEPA Order - Module Ecommerce - Online store Order - Module Warehouse Order line - Module Warehouse Package - Module Multipack Package reservation type - Module Multipack Participant - Module Bookings Core Payment - Module Core Sales Payment method - Module Core Sales Period - Module School plans Product - Module Core Sales Product filter - Module Vouchers Profile - Module System Receipt - Module Invoicing Receipt omitted - Module Subscriptions Resource - Module Bookings Core Resource type - Module Bookings Core Sale - Module Core Sales Share - Module Shares Share transfer - Module Shares Shopping cart - Module Checkout online Subfamily - Module Core Sales Subscription - Module Subscriptions Subscription type - Module Subscriptions Tenants Transaction - Module Vouchers User - Module System Voucher - Module Vouchers Voucher type - Module Vouchers VoucherPrice - Module Vouchers

Introduction

Authentication

To authenticate your requests, include a header named "key" with the API Key as its value.

For example: curl -H "key: [API Key]" "https://dev.v3manager.com/api/model/customer?tenant=demo"

Dates

All dates are expressed in the tenant's local time.

Both ISO and unix formats are supported.

For example, 2024-01-20T20:00:00 or 1705777200.

Pagination

Responses from the API are paginated. To limit the number of results, use the limit parameter. The default limit is 20, with a maximum of 100. If more results are available, the response will include "hasMore": true. To retrieve the next page, use the lastId parameter from the previous response.

Example

curl -H "key: [API Key]" "https://dev.v3manager.com/api/model/customer?tenant=demo" { "data": [ { "firstName": "Alicia García", "id": 1, "name": "Alicia García" } ], "hasMore": true, "lastId": 1 }

To read the next page, pass the lastId parameter included in the response

curl -H "key: [API Key]" "https://dev.v3manager.com/api/model/customer?tenant=demo&lastId=1" { "data": [ { "firstName": "Juan García", "id": 7, "name": "Juan García" } ], "hasMore": true, "lastId": 7 }

Fields

You can specify the fields that you want in the response. The id field is always present

https://dev.v3manager.com/api/model/sale?tenant=demo&fields=["description", "total"]

Filters

To filter list requests the format is [field, operator, value]. For example:

https://dev.v3manager.com/api/model/sale?tenant=demo&search=["created",">","05-07-2023"]

Filter by null:

["end","=",null]

Include deleted records:

["deleted","in",[0,1]]

Nest filters:

["OR", ["status","in",[3,4]], ["price","=",0]]

Example: filter records created or updated since a date

["OR", ["created",">","2023-07-01"], ["updated",">","2023-07-01"]]

Action file - Module Shares

Read

GET https://dev.v3manager.com/api/model/shareFile

Create or update

POST https://dev.v3manager.com/api/model/shareFile

Fields

Name Label Type Required Readonly
id ID int yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Addon - Module Subscriptions

Read

GET https://dev.v3manager.com/api/model/subscriptionAddon

Create or update

POST https://dev.v3manager.com/api/model/subscriptionAddon

Fields

Name Label Type Required Readonly
id ID int yes yes
subscriptionCustomer int no yes
customer Customer string no yes
product Product int no yes
price Custom price currency no no
start Start date no no
end End date no no
comments Private observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Area - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingArea

Create or update

POST https://dev.v3manager.com/api/model/bookingArea

Fields

Name Label Type Required Readonly
id ID int yes yes
code Code string no no
name Name string no yes
image Image image no no
startTime Start time time no yes
endTime End time time no yes
increment Increment duration no yes
timeout Prebooking timeout duration no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Beneficiary - Module Subscriptions

Read

GET https://dev.v3manager.com/api/model/subscriptionBeneficiary

Create or update

POST https://dev.v3manager.com/api/model/subscriptionBeneficiary

Fields

Name Label Type Required Readonly
id ID int yes yes
subscriptionCustomer Subscription int no yes
customer Customer int no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Blocking - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingBlocking

Create or update

POST https://dev.v3manager.com/api/model/bookingBlocking

Fields

Name Label Type Required Readonly
id ID int yes yes
name Name string no yes
area Area int no no
resource Resource int no no
bgColor Color color no no
comments Observations text no no
allowCrossings Allow crossings bool no yes
tags Customer tags manyToMany no no
timeout Expiration duration no no
allowAdmin Allow bookings from admin side bool no yes
slots Slots int no no
startDate Start date date no no
endDate End date date no no
daysOfWeek Days of the week daysOfWeek no no
startTime Start time time no no
endTime End time time no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Booking - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/booking

Create or update

POST https://dev.v3manager.com/api/model/booking

Fields

Name Label Type Required Readonly
id ID int yes yes
reference Locator string yes yes
description Description string no no
name Name string no no
customer Customer int no no
area Area int yes yes
resource Resource int no yes
type Booking type int no no
categoryName Category string no yes
start Start date datetime no yes
end End date datetime no yes
cancelation Cancellation date datetime no no
crossing Crossing bool yes yes
extra Extra bool yes yes
minCapacity Minimum places int no no
maxCapacity Máximo Plazas int no no
payPerPerson Price per person bool no yes
hasParticipants It has participants bool no yes
parent Main booking int no no
timeout Expiration date datetime yes no
product Product int no no
sale Sale int yes no
checkin Checkin bool no yes
checkout Checkout bool no yes
price Price currency no yes
status Status select yes yes
needInfo Requires information bool yes yes
online Created online bool yes yes
notify Notify bool no yes
remind Reminder bool no yes
noShow No show bool no yes
confirmationSent Confirmation sent bool yes yes
reminderSent Reminder envoy bool no yes
byDays Book by days bool no yes
origin Origin int no no
tag Tag string no no
comments Observations text no no
onlineComments Online observations text no no
multipack Pack int no no
pin PIN string no no
automaticExtras Automatic extras json no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for status
Value Name
0 Draft
1 For free
2 Not paid
3 Paid
4 Cancelled

Booking type - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingType

Create or update

POST https://dev.v3manager.com/api/model/bookingType

Fields

Name Label Type Required Readonly
id ID int yes yes
identifyMode Identification form select no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for identifyMode
Value Name
1 Name
2 Membership number
3 Search client
100 Relations

Client Archives - Module Customers

Read

GET https://dev.v3manager.com/api/model/customerFile

Create or update

POST https://dev.v3manager.com/api/model/customerFile

Fields

Name Label Type Required Readonly
id ID int yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Comment - Module Tasks

Read

GET https://dev.v3manager.com/api/model/taskComment

Create or update

POST https://dev.v3manager.com/api/model/taskComment

Fields

Name Label Type Required Readonly
id ID int yes yes
body Description markdown no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Company - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/company

Create or update

POST https://dev.v3manager.com/api/model/company

Fields

Name Label Type Required Readonly
id ID int yes yes
footerText Invoice footer text text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Contact - Module CRM

Read

GET https://dev.v3manager.com/api/model/crmContact

Create or update

POST https://dev.v3manager.com/api/model/crmContact

Fields

Name Label Type Required Readonly
id ID int yes yes
name Full name string no yes
avatar Image image no no
email Email email no no
email2 Another email email no no
phone Phone string no no
phone2 Another phone string no no
gender Gender select no no
street Street string no no
street2 Street 2 string no no
city City string no no
region Region int no no
zipCode Zip Code string no no
country Country int no no
birthdate Birthdate date no no
language Language select no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for gender
Value Name
0 Male
1 Female
Values for language
Value Name
es Spanish
en English

Courses - Module School

Read

GET https://dev.v3manager.com/api/model/courseType

Create or update

POST https://dev.v3manager.com/api/model/courseType

Fields

Name Label Type Required Readonly
id ID int yes yes
tags Course type labels manyToMany no no
extrasTag Extras label int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Customer - Module Customers

Read

GET https://dev.v3manager.com/api/model/customer

Create or update

POST https://dev.v3manager.com/api/model/customer

Fields

Name Label Type Required Readonly
id ID int yes yes
name Full name string no yes
firstName Name string no yes
lastName Surnames string no no
alias Alias string no no
description Description text no no
avatar Image image no no
isCompany It is a company bool no yes
email Email email no no
email2 Another email email no no
phone Phone string no no
phone2 Another phone string no no
taxNumber Tax number string no no
taxExempt Tax exempt bool no yes
memberCode Membership number string no no
centerCard Center card number string no no
businessName Business name string no no
gender Gender select no no
street Street string no no
street2 Street 2 string no no
city City string no no
region Region int no no
zipCode Zip Code string no no
country Country int no no
birthdate Birthdate date no no
company Company int no no
tags Tags manyToMany no no
language Language select no no
disabled Blocked bool no yes
paymentCondition Payment conditions select no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for gender
Value Name
0 Male
1 Female
Values for language
Value Name
es Spanish
en English
Values for paymentCondition
Value Name
0 Early payment
1 15 days
2 30 days
3 60 days
4 90 days

Customer tag - Module Customers

Read

GET https://dev.v3manager.com/api/model/customerTag

Create or update

POST https://dev.v3manager.com/api/model/customerTag

Fields

Name Label Type Required Readonly
id ID int yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Detailed charges - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/salePayment

Fields

Name Label Type Required Readonly
id ID int yes yes
refunded Cancelled bool yes yes
virtual Virtual bool yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Documentation - Module Documentation

Read

GET https://dev.v3manager.com/api/model/kbaseArticle

Create or update

POST https://dev.v3manager.com/api/model/kbaseArticle

Fields

Name Label Type Required Readonly
id ID int yes yes
tags Tags manyToMany no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Dynamic price - Module Dynamic prices

Read

GET https://dev.v3manager.com/api/model/dynamicPrice

Create or update

POST https://dev.v3manager.com/api/model/dynamicPrice

Fields

Name Label Type Required Readonly
id ID int yes yes
customerTags Customer tags manyToMany no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Dynamic price tag - Module Dynamic prices

Read

GET https://dev.v3manager.com/api/model/dynamicPriceToCustomerTag

Create or update

POST https://dev.v3manager.com/api/model/dynamicPriceToCustomerTag

Fields

Name Label Type Required Readonly
id ID int yes yes
price int no yes
tag int no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Help article - Module Help (Server)

Read

GET https://dev.v3manager.com/api/model/helpArticle

Create or update

POST https://dev.v3manager.com/api/model/helpArticle

Fields

Name Label Type Required Readonly
id ID int yes yes
tags Tags manyToMany no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Invoice - Module Invoicing

Read

GET https://dev.v3manager.com/api/model/invoice

Create or update

POST https://dev.v3manager.com/api/model/invoice

Fields

Name Label Type Required Readonly
id ID int yes yes
type Type int no yes
customer Customer int no no
paidFor Paid to int no no
name Name or Social reason string no no
taxNumber Tax number string no no
address Address text no no
street Street string no no
street2 Street 2 string no no
zipCode Zip Code string no no
city City string no no
regionName Region string no no
country Country int no no
countryIsoCode Country string no no
countryName Country string no no
company Company int no no
companyName Company name string no no
companyTaxNumber NIF company string no no
companyAddress Company address text no no
companyStreet Company street string no no
companyStreet2 Company street 2 string no no
companyZipCode Company Zip Code string no no
companyCity Company city string no no
companyRegionName Company region string no no
companyCountry Country int no no
companyCountryIsoCode Company Country Code string no no
companyCountryName Company country string no no
companyPhone Company telephone string no no
number Invoice number string yes no
counter Serie int no no
totalBeforeTaxes Total before taxes currency yes yes
total Total currency yes yes
discounts Discounts currency yes yes
companyInfo Company information text no no
date Date date no no
dueDate Due date date yes no
taxExempt Tax exempt bool no yes
publicComments Public comments text no no
footerText Invoice footer text text no no
comments Observations text no no
online Created online bool yes yes
status Status select yes yes
paymentCondition Payment conditions select yes no
paymentStatus Payment status select yes no
sendStatus Shipping status select yes no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for status
Value Name
0 Draft
1 Confirmed
2 Cancelled
Values for paymentCondition
Value Name
0 Early payment
1 15 days
2 30 days
3 60 days
4 90 days
Values for paymentStatus
Value Name
0 Not paid
1 Partially paid
2 Paid
Values for sendStatus
Value Name
1 Pending Shipping
2 Sent
3 Shipping error

Invoice payment - Module Invoicing

Read

GET https://dev.v3manager.com/api/model/invoicePayment

Fields

Name Label Type Required Readonly
id ID int yes yes
paymentMethod Payment method int no yes
comments Observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Invoice series - Module Invoicing

Read

GET https://dev.v3manager.com/api/model/invoiceCounter

Create or update

POST https://dev.v3manager.com/api/model/invoiceCounter

Fields

Name Label Type Required Readonly
id ID int yes yes
company Company int no no
type Type int no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Line Q19 - Module SEPA

Read

GET https://dev.v3manager.com/api/model/q19Line

Fields

Name Label Type Required Readonly
id ID int yes yes
status Status select yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for status
Value Name
0 Pending
1 Paid
2 Returned
3 Returned and excluded

Order - Module Ecommerce - Online store

Read

GET https://dev.v3manager.com/api/model/ecommerceOrder

Create or update

POST https://dev.v3manager.com/api/model/ecommerceOrder

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int no no
shippingAddress Address int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Order - Module Warehouse

Read

GET https://dev.v3manager.com/api/model/stockOrder

Create or update

POST https://dev.v3manager.com/api/model/stockOrder

Fields

Name Label Type Required Readonly
id ID int yes yes
supplier Supplier int no no
date Order date date no no
estimatedDeliveryDate Estimated date of reception date no no
deliveryDate Deadline date no no
globalDiscount Global discount float no yes
comments Observations text no no
lines Lines StockOrderLine[] no yes
status Status select no yes
amount Amount float yes yes
received Received float yes yes
total Total float yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for status
Value Name
0 Open
1 Sent
2 Partially received
3 Received

Order line - Module Warehouse

Read

GET https://dev.v3manager.com/api/model/stockOrderLine

Create or update

POST https://dev.v3manager.com/api/model/stockOrderLine

Fields

Name Label Type Required Readonly
id ID int yes yes
stockOrder Order int no yes
product Product int no yes
grossUnitCost Gross cost currency no yes
total Total float yes yes
amount Amount float no yes
discount Discount float no yes
received Received float yes yes
pending Pending float yes yes
difference Difference float yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Package - Module Multipack

Read

GET https://dev.v3manager.com/api/model/multipack

Create or update

POST https://dev.v3manager.com/api/model/multipack

Fields

Name Label Type Required Readonly
id ID int yes yes
start Start date date no no
end End date date no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Package reservation type - Module Multipack

Read

GET https://dev.v3manager.com/api/model/multipackItem

Create or update

POST https://dev.v3manager.com/api/model/multipackItem

Fields

Name Label Type Required Readonly
id ID int yes yes
pack Pack int no no
type Booking type int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Participant - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingParticipant

Create or update

POST https://dev.v3manager.com/api/model/bookingParticipant

Fields

Name Label Type Required Readonly
id ID int yes yes
onlineComments Online observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Payment - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/payment

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int yes no
method Payment method int no yes
amount Amount currency yes yes
refunded Returned bool yes yes
online Online bool yes yes
virtual Virtual bool yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Payment method - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/paymentMethod

Create or update

POST https://dev.v3manager.com/api/model/paymentMethod

Fields

Name Label Type Required Readonly
id ID int yes yes
virtual Virtual bool yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Period - Module School plans

Read

GET https://dev.v3manager.com/api/model/schoolPlanningExercise

Create or update

POST https://dev.v3manager.com/api/model/schoolPlanningExercise

Fields

Name Label Type Required Readonly
id ID int yes yes
tags Tags manyToMany no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Product - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/product

Create or update

POST https://dev.v3manager.com/api/model/product

Fields

Name Label Type Required Readonly
id ID int yes yes
name Name string no yes
price Price currency no yes
taxes Taxes manyToMany no no
tags Tags manyToMany no no
perHour By hours bool no yes
subfamily Subfamily int no no
roundingError bool no yes
priority Priority int no no
shipping Shipping costs bool no yes
ballsQuantity Balls amount int no no
barcode Barcode string no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Product filter - Module Vouchers

Read

GET https://dev.v3manager.com/api/model/voucherProduct

Create or update

POST https://dev.v3manager.com/api/model/voucherProduct

Fields

Name Label Type Required Readonly
id ID int yes yes
type Type int no yes
product Product int no yes
ratio Ratio float no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Profile - Module System

Read

GET https://dev.v3manager.com/api/model/profile

Create or update

POST https://dev.v3manager.com/api/model/profile

Fields

Name Label Type Required Readonly
id ID int yes yes
azureId Azure ID string no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Receipt - Module Invoicing

Read

GET https://dev.v3manager.com/api/model/invoiceReceipt

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int no no
comments Observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Receipt omitted - Module Subscriptions

Read

GET https://dev.v3manager.com/api/model/ommitedSale

Create or update

POST https://dev.v3manager.com/api/model/ommitedSale

Fields

Name Label Type Required Readonly
id ID int yes yes
subscriptionCustomer Subscription int no yes
issueDate Date date no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Resource - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingResource

Create or update

POST https://dev.v3manager.com/api/model/bookingResource

Fields

Name Label Type Required Readonly
id ID int yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Resource type - Module Bookings Core

Read

GET https://dev.v3manager.com/api/model/bookingResourceType

Create or update

POST https://dev.v3manager.com/api/model/bookingResourceType

Fields

Name Label Type Required Readonly
id ID int yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Sale - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/sale

Create or update

POST https://dev.v3manager.com/api/model/sale

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int no no
customerTaxNumber ID string no no
beneficiary Beneficiary int no no
paidFor Paid to int yes no
taxExempt Tax exempt bool yes yes
description Description string no yes
product Product int no yes
price Unit price currency no yes
units Units float no yes
discountRate % Discount percent no yes
taxes Taxes SaleTax[] no no
total Total currency no yes
totalBeforeTaxes Total before taxes currency no yes
allowPaymentPending Allow pending payment bool no yes
status Status select yes yes
cancelationOf Cancellation of int yes no
parent Line on which it depends int yes no
link Linked to int yes no
dueDate Due date datetime no yes
useDate Production date datetime no yes
timeout Expiration datetime no no
online Online bool yes yes
company Company int no no
comments Observations text no no
publicComments Public comments text no no
invoice Invoice int yes no
proforma Proforma int yes no
invoiced Billed bool yes yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for status
Value Name
0 Draft
1 For free
2 Not paid
3 Paid
4 Cancelled
5 Cancellation

Share - Module Shares

Read

GET https://dev.v3manager.com/api/model/share

Create or update

POST https://dev.v3manager.com/api/model/share

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Share transfer - Module Shares

Read

GET https://dev.v3manager.com/api/model/shareTransfer

Create or update

POST https://dev.v3manager.com/api/model/shareTransfer

Fields

Name Label Type Required Readonly
id ID int yes yes
share Share int no yes
seller Seller int no yes
buyer Buyer int no yes
price Price currency no yes
date Date date no yes
comments Observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Shopping cart - Module Checkout online

Read

GET https://dev.v3manager.com/api/model/shopCart

Fields

Name Label Type Required Readonly
id ID int yes yes
shippingAddress Address int no no
shippingCost Shipping costs int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Subfamily - Module Core Sales

Read

GET https://dev.v3manager.com/api/model/subfamily

Create or update

POST https://dev.v3manager.com/api/model/subfamily

Fields

Name Label Type Required Readonly
id ID int yes yes
company Company int no no
recommendedTag Recommended products int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Subscription - Module Subscriptions

Read

GET https://dev.v3manager.com/api/model/subscriptionCustomer

Create or update

POST https://dev.v3manager.com/api/model/subscriptionCustomer

Fields

Name Label Type Required Readonly
id ID int yes yes
type Subscription type int no yes
customer Customer int no yes
start Start date no yes
end End date no no
price Custom price currency no no
comments Private observations text no no
publicComments Invoice observations text no no
active Active bool no yes
fkModel int yes no
fkId int yes no
sale int yes no
language string no yes
directDebit Direct debit bool no no
share Share int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Subscription type - Module Subscriptions

Read

GET https://dev.v3manager.com/api/model/subscription

Create or update

POST https://dev.v3manager.com/api/model/subscription

Fields

Name Label Type Required Readonly
id ID int yes yes
name Name string no yes
period Periodicity select no yes
apportionment Prorate bool no yes
product Product int no yes
customerTag Will assign this tag int no no
beneficiaryTag Beneficiary tag int no no
online Online sale bool no yes
image Image image no no
description Description text no no
expiration Expiration duration no no
customers Customers int no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for period
Value Name
0 Single payment
1 Monthly
20 Bimonthly
30 Quarterly
60 Biannual
120 Annual


Tenants

Returns all the tenants that the API Key has access to.

curl -H "key: [API Key]" "https://dev.v3manager.com/api/tenants"

[
  {
    "name": "demo1"
  },
  {
    "name": "demo2"
  },
]

Transaction - Module Vouchers

Read

GET https://dev.v3manager.com/api/model/voucherTransaction

Fields

Name Label Type Required Readonly
id ID int yes yes
voucher Voucher int no yes
description Description string no yes
sale Sale int no no
salePayment int no no
payment Payment int no no
amount Amount float no yes
balanceAfter Balance float no yes
unitPrice currency no yes
useDate Production date datetime no yes
fkModel int yes no
fkId int yes no
ratio Ratio float no no
refunded Back bool no yes
type Type select no yes
voucherType Type string no yes
customerName Customer string no yes
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for type
Value Name
1 Top up
2 Consumption
3 Manual
4 Bulk Top up

User - Module System

Read

GET https://dev.v3manager.com/api/model/user

Create or update

POST https://dev.v3manager.com/api/model/user

Fields

Name Label Type Required Readonly
id ID int yes yes
company Company int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Voucher - Module Vouchers

Read

GET https://dev.v3manager.com/api/model/voucher

Create or update

POST https://dev.v3manager.com/api/model/voucher

Fields

Name Label Type Required Readonly
id ID int yes yes
customer Customer int no yes
type Type int no yes
unitPrice Price per unit currency no yes
balance Balance float no yes
startDate Valid from date no no
endDate Valid until date no no
startTime Time from time no no
endTime Time until time no no
daysOfWeek Days of the week daysOfWeek no no
comments Observations text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no

Voucher type - Module Vouchers

Read

GET https://dev.v3manager.com/api/model/voucherType

Create or update

POST https://dev.v3manager.com/api/model/voucherType

Fields

Name Label Type Required Readonly
id ID int yes yes
name Name string no yes
kind Type select no yes
product Product int no yes
shortDescription Short description string no no
expiration Expiration duration no no
startTime Time from time no no
endTime Time until time no no
daysOfWeek Days of the week daysOfWeek no no
customerTag Will assign this tag int no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no
Values for kind
Value Name
1 Money
3 Units

VoucherPrice - Module Vouchers

Read

GET https://dev.v3manager.com/api/model/voucherPrice

Create or update

POST https://dev.v3manager.com/api/model/voucherPrice

Fields

Name Label Type Required Readonly
id ID int yes yes
type Type int no yes
tagFilter Filter tag int no no
amount Top up amount int no yes
price Price currency no yes
online Available online bool no yes
description Description text no no
created Creation date datetime yes yes
createUser Created by int yes no
updated Update date datetime yes no
updateUser Updated by int yes no