Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 4.61 KB

DocumentTypeViewModel.md

File metadata and controls

35 lines (31 loc) · 4.61 KB
Raw

SiigoApi.DocumentTypeViewModel

Properties

Name Type Description Notes
id Number Represents the id of the document type, the value of this field must be an integer number that represents the unique id of the document type. For example '5636'. [optional]
code String Represents the document type code. This value must be an integer code that will represent the code id of the document type. For example, '1'. [optional]
name String Represents the name of the document type. This value can be an alphanumeric name like 'Factura' (invoice). [optional]
description String Represents the description of the document type. For example, 'This is a description'. [optional]
type String Represents the document types. This type can be 'FV' to invoices, 'RC' to vouchers, 'NC' to credit notes, 'FC' to purchases or, 'CC' to journals. [optional]
active Boolean Represents if document type status is activated or disabled, the value of this status will be true (for activated) or false (disabled). By default, this field will be true. [optional]
sellerByItem Boolean Represents if the document type Handles a seller by item or not. This field can be 'true' or 'false'. [optional]
costCenter Boolean Represents if the document type Handles a cost center or not. This field can be 'true' or 'false'. [optional]
costCenterMandatory Boolean Represents if the document type Handles a required cost center or not. This field can be 'true' or 'false'. [optional]
costCenterDefault Number Represents the id number of the default cost center. By default, this field will be null. [optional]
automaticNumber Boolean Represents if the document type Handles automatic numbering or not. This field can be 'true' or 'false'. [optional]
consecutive Number Represents the consecutive number of the document type. [optional]
discountType String Represents if the document type Manages a percentage or a value to discounts. This field can be 'Percentage' or 'Value'. [optional]
decimals Boolean Represents if the document type handles Handles decimals or not. This field can be 'true' or 'false'. [optional]
advancePayment Boolean Represents if the document type handles Manage copayments/advances or not. This field can be 'true' or 'false'. [optional]
reteiva Boolean Represents if the document type handles 'Reteiva' or not. This field can be 'true' or 'false'. [optional]
reteica Boolean Represents if the document type handles 'Reteica' or not. This field can be 'true' or 'false'. [optional]
selfWithholding Boolean Represents if the document type handles self-withholding decree 2201 or not. This field can be 'true' or 'false'. [optional]
selfWithholdingLimit Number Represents the self withholding limit, the self withholding value will be applied only for values greater than the specified limit. By default, this field will be null. [optional]
electronicType String Represents the type of the invoice. This type can be 'NoElectronic', 'Electronicvoice', 'ContingencyInvoice' or 'ExportInvoice'. [optional]
officialBook String Represents the official book type of the Journals. This value can be '0' to sales book, '1' to sales returns book, '2' to purchase book, or '3' to purchase return book. [optional]
documentSupport Boolean Represents if the Journals supports documents or not. [optional]
prefix String Invoice prefix to which the credit or payent will be applied. For example, 'FV-1'. [optional]
globalDiscounts [DocumentTypeTaxModel] Contains information about the global discounts associated with document type. [optional]
globalCharges [DocumentTypeTaxModel] Contains information about the global charges associated with document type. [optional]
cargoTransportation Boolean Represents whether the document type is available for cargo transport. [optional]
iSR Boolean Represent if the document allows ISR. This field is only for Mexico. [optional]