Billing Models
Cobro
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/payment/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/payment
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| customer |
Cliente |
int |
no |
yes |
| method |
Forma de pago |
int |
yes |
no |
| amount |
Cantidad |
currency |
yes |
yes |
| refunded |
Devuelto |
bool |
yes |
yes |
| compensation |
Compensación |
bool |
yes |
yes |
| online |
Online |
bool |
yes |
yes |
| virtual |
Virtual |
bool |
yes |
yes |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Cobro desglosado
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/salePayment/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/salePayment
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| sale |
Venta |
int |
yes |
no |
| parent |
|
int |
no |
no |
| payment |
Cobro |
int |
yes |
no |
| units |
Unidades |
float |
yes |
no |
| amount |
Cantidad |
currency |
yes |
no |
| refunded |
Anulado |
bool |
yes |
yes |
| virtual |
Virtual |
bool |
yes |
yes |
| paymentMethodName |
Forma de pago |
string |
yes |
no |
| customer |
Cliente |
int |
yes |
no |
| customerName |
Cliente |
string |
yes |
no |
| useDate |
Fecha de uso |
date |
yes |
no |
| productName |
Producto |
string |
yes |
no |
| familyName |
Familia |
string |
yes |
no |
| subfamilyName |
Subfamilia |
string |
yes |
no |
| invoice |
Factura |
int |
no |
yes |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Empresa
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/company/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/company
Create
POST https://dev.v3manager.com/api/model/company
Update
POST https://dev.v3manager.com/api/model/company/[id]
Delete
DELETE https://dev.v3manager.com/api/model/company/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| footerText |
Texto pie de factura |
text |
no |
no |
| creditNoteFooterText |
Texto pie de factura rectificativa |
text |
no |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Etiqueta de producto
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/productTag/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/productTag
Create
POST https://dev.v3manager.com/api/model/productTag
Update
POST https://dev.v3manager.com/api/model/productTag/[id]
Delete
DELETE https://dev.v3manager.com/api/model/productTag/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| name |
Nombre |
string |
yes |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Familia
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/family/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/family
Create
POST https://dev.v3manager.com/api/model/family
Update
POST https://dev.v3manager.com/api/model/family/[id]
Delete
DELETE https://dev.v3manager.com/api/model/family/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| name |
Nombre |
string |
yes |
no |
| code |
Código |
string |
no |
no |
| useStock |
Gestionar stock |
bool |
yes |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Forma de pago
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/paymentMethod/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/paymentMethod
Create
POST https://dev.v3manager.com/api/model/paymentMethod
Update
POST https://dev.v3manager.com/api/model/paymentMethod/[id]
Delete
DELETE https://dev.v3manager.com/api/model/paymentMethod/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| name |
Nombre |
string |
yes |
no |
| consumerName |
Nombre Consumer |
string |
no |
no |
| color |
Color |
color |
no |
no |
| type |
Tipo |
select |
yes |
no |
| maxAmount |
Máximo importe permitido |
float |
no |
no |
| priority |
Prioridad |
int |
yes |
no |
| consumer |
Disponible online |
bool |
yes |
no |
| pos |
TPV |
bool |
yes |
no |
| unattended |
Automatizable |
bool |
yes |
no |
| refund |
Devolución en TPV |
bool |
yes |
no |
| refundProvider |
Proveedor de devoluciones |
bool |
yes |
no |
| productTag |
Tag de producto |
int |
no |
no |
| virtual |
Virtual |
bool |
yes |
no |
| apiEnabled |
Válido en API |
bool |
yes |
no |
| surcharges |
Recargo |
percent |
no |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Values for type
| Value |
Name |
| 0 |
Personalizado |
| 1 |
Dinero |
| 2 |
Tarjeta |
| 3 |
Transferencia |
| 4 |
Domiciliación |
| 5 |
Pasarela |
| 6 |
Depósito |
| 7 |
Bono |
| 8 |
Opera |
Impuesto
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/tax/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/tax
Create
POST https://dev.v3manager.com/api/model/tax
Update
POST https://dev.v3manager.com/api/model/tax/[id]
Delete
DELETE https://dev.v3manager.com/api/model/tax/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| code |
Código |
string |
no |
no |
| name |
Nombre |
string |
yes |
no |
| rate |
Porcentaje |
percent |
yes |
no |
| account |
Cuenta contable |
string |
no |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
ProductToTag
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/productToTag/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/productToTag
Create
POST https://dev.v3manager.com/api/model/productToTag
Update
POST https://dev.v3manager.com/api/model/productToTag/[id]
Delete
DELETE https://dev.v3manager.com/api/model/productToTag/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| product |
|
int |
yes |
no |
| productTag |
|
int |
yes |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Producto
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/product/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/product
Create
POST https://dev.v3manager.com/api/model/product
Update
POST https://dev.v3manager.com/api/model/product/[id]
Delete
DELETE https://dev.v3manager.com/api/model/product/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| name |
Nombre |
string |
yes |
no |
| image |
Imagen |
image |
no |
no |
| price |
Precio |
currency |
yes |
no |
| taxes |
Impuestos |
manyToMany |
no |
no |
| tags |
Etiquetas |
manyToMany |
no |
no |
| perHour |
Por horas |
bool |
yes |
no |
| subfamily |
Subfamilia |
int |
no |
no |
| roundingError |
|
bool |
yes |
no |
| priority |
Prioridad |
int |
no |
no |
| sid |
|
string |
yes |
no |
| account |
Cuenta contable |
string |
no |
no |
| divisible |
Divisible |
bool |
yes |
no |
| shipping |
Gastos de envío |
bool |
yes |
no |
| ballsQuantity |
Cantidad de bolas a entregar |
int |
no |
no |
| hasIngredients |
Tiene ingredientes |
bool |
yes |
no |
| barcode |
Código de barras |
string |
no |
no |
| sku |
Código SKU |
string |
no |
no |
| supplier |
Proveedor |
int |
no |
no |
| supplierBarcode |
Código de barras proveedor |
string |
no |
no |
| brand |
Marca |
int |
no |
no |
| useStock |
Gestionar stock |
bool |
yes |
no |
| costPrice |
Último precio de compra |
currency |
no |
yes |
| inDeposit |
En depósito |
bool |
yes |
no |
| buyTax |
Impuesto de compra |
int |
no |
no |
| baseProduct |
Producto de base |
int |
no |
no |
| basePercent |
Porcentaje de base |
percent |
no |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Retención de fondos
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/hold/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/hold
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| customer |
Cliente |
int |
no |
yes |
| method |
Forma de pago |
int |
yes |
no |
| amount |
Cantidad |
currency |
yes |
yes |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Subfamilia
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/subfamily/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/subfamily
Create
POST https://dev.v3manager.com/api/model/subfamily
Update
POST https://dev.v3manager.com/api/model/subfamily/[id]
Delete
DELETE https://dev.v3manager.com/api/model/subfamily/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| family |
Familia |
int |
yes |
no |
| name |
Nombre |
string |
yes |
no |
| code |
Código |
string |
no |
no |
| company |
Empresa |
int |
no |
no |
| supply |
Suplidos |
bool |
yes |
no |
| account |
Cuenta contable |
string |
no |
no |
| recommendedTag |
Productos recomendados |
int |
no |
no |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Venta
Endpoints
Retrieve by ID
GET https://dev.v3manager.com/api/model/sale/[id]
Retrieve many
GET https://dev.v3manager.com/api/model/sale
Create
POST https://dev.v3manager.com/api/model/sale
Update
POST https://dev.v3manager.com/api/model/sale/[id]
Delete
DELETE https://dev.v3manager.com/api/model/sale/[id]
Fields
| Name |
Label |
Type |
Required |
Readonly |
| id |
Referencia |
int |
no |
yes |
| name |
Nombre |
string |
no |
no |
| customer |
Cliente |
int |
no |
no |
| customerTaxNumber |
DNI |
string |
no |
no |
| beneficiary |
Beneficiario |
int |
no |
no |
| taxExempt |
Exento de impuestos |
bool |
yes |
yes |
| description |
Descripción |
string |
yes |
no |
| product |
Producto |
int |
yes |
no |
| price |
Precio unitario |
currency |
yes |
no |
| units |
Unidades |
float |
yes |
no |
| discountRate |
% Descuento |
percent |
yes |
no |
| taxes |
Impuestos |
SaleTax[] |
no |
no |
| total |
Total |
currency |
yes |
no |
| totalBeforeTaxes |
Total sin impuestos |
currency |
yes |
no |
| allowPaymentPending |
Permitir pendiente de pago |
bool |
yes |
no |
| status |
Estado |
select |
yes |
yes |
| hold |
Retención de fondos |
int |
no |
no |
| cancelationOf |
Cancelación de |
int |
no |
yes |
| parent |
Línea de la que depende |
int |
no |
yes |
| link |
Enlazada a |
int |
no |
yes |
| dueDate |
Fecha de vencimiento |
date |
yes |
no |
| useDate |
Fecha de uso |
datetime |
yes |
no |
| timeout |
Caducidad |
datetime |
no |
no |
| fkModel |
|
fkModel |
no |
yes |
| fkId |
|
int |
no |
yes |
| online |
Online |
bool |
yes |
yes |
| company |
Empresa |
int |
no |
no |
| comments |
Observaciones |
text |
no |
no |
| publicComments |
Observaciones públicas |
text |
no |
no |
| discountReasons |
Motivos de descuento |
int |
no |
no |
| invoice |
Factura |
int |
no |
yes |
| proforma |
Proforma |
int |
no |
yes |
| invoiced |
Facturada |
bool |
yes |
yes |
| invoiceDate |
Fecha de factura |
date |
no |
yes |
| created |
Fecha de creación |
datetime |
no |
yes |
| createUser |
Creado por |
int |
no |
yes |
| updated |
Fecha de actualización |
datetime |
no |
yes |
| updateUser |
Actualizado por |
int |
no |
yes |
| deleted |
Eliminado |
bool |
no |
yes |
Values for status
| Value |
Name |
| 0 |
Borrador |
| 1 |
Sin coste |
| 2 |
Pendiente de pago |
| 3 |
Pagada |
| 4 |
Anulada |
| 5 |
Anulación |