PROTEL PORTAL PLUS
Online documentation
Invoice
Main invoice record
| Property Name | Type | Description |
| IntId | int | Primary key in local database |
| InvoiceId | string * [Required] |
Source system Invoice Id Maximum length:60 |
| DocType | DocType ? * [Required] | Main invoice type (earchive, einvoice,..) |
| IsEInvoice | bool * [Deprecated] Use DocType instead of this. | True = e-invoice |
| IsEArchive | bool * [Deprecated] Use DocType instead of this | is e-archive invoice |
| ManualInvoiceNo | string |
Invoice No on the paper Maximum length:100 |
| OrderNo | string |
Order number Maximum length:500 |
| OrderDate | DateTime? | Order Date |
| DespatchNo | string |
dispatch number Maximum length:100 |
| DespatchDate | DateTime? | dispatch date |
| SupplierNo | string |
Supplier no Maximum length:100 |
| CustomerDespatchAddress | string |
Customer despatch address Maximum length:100 |
| FolioNo | string |
Folio no is used by outgoing hotel invoices like suite8 or opera Maximum length:500 |
| FicheNo | string |
Fiche no of systems like Logo/Netsis Maximum length:50 |
| CheckNo | string |
Check no of systems like Micros Maximum length:50 |
| ExternalTrackNo | string |
This is EInvoice integrator invoice number (eg: Netle Invoice Id) Maximum length:100 |
| FolderIntId | int? * [Required] | Refers to a portal+ folder id that this invoice will be listed inside. |
| SourceIntId | int? | Source id of the invoice (EG: The Marmara Istanbul - Suite8, or Starbucks Üsküdar - MC, these are all added as a source in portal+) |
| CreatedOn | DateTime | Record insert datetime |
| CreatedBy | int | References which portal+ user inserted this record |
| ModifiedOn | DateTime | Last invoice modify date |
| ModifiedBy | int? | References which portal+ user inserted this record, null means "portal+ system" |
| ErrorMessage | string |
Error message (if invoice is in error status) Max Size: 500 |
| InvoiceNo | string |
This 16 digit alphanumeric value is generated by a provider (eg:logoprovider) or by portal+. The format of the invoice number is 3 letter code + year + counter. eg: AAA2013000000001 Maximum length:20 |
| EnvelopeNo | string |
GIB Envelope No (GUID) Maximum length:40 |
| Description | string |
Invoice decription Maximum length:500 |
| Description2 | string |
Additional invoice decription (can be entered manually by user with PortalPlus UI) Maximum length:500 |
| InvoiceDate | DateTime * [Required] | Date of the invoice (only date part) |
| InvoiceTime | DateTime | ? |
| InvoiceType | InvoiceType * [Required] | type of invoice (sales or return) |
| ScenarioType | ScenarioType * [Required] Mandatory for einvoice,Optional for earchive | scenario is basic or commercial |
| TotalAmount | decimal? | Total amount |
| TotalPayAmount | decimal? | Total pay amount |
| CurrencyCode | string |
3 character currency ISO code Maximum length:3 |
| ForeignCurrCode | string |
Foreign Currency Code for Invoice Total Maximum length:3 |
| ForeignCurrRate | decimal? |
Foreign Currency Rate for Invoice Total Maximum length:3 |
| DiscountAmount | decimal? | discount amount |
| TaxableAmount | decimal? | taxable total amount |
| AccTaxAmount | decimal? | Accommodation total tax amount |
| RoundingAmount | decimal? | rounding amount |
| TaxAmount | decimal? | tax amount |
| WithholdingTax | decimal? | witholding tax |
| TaxExemption | decimal? * [Required] Mandatory for Zero amount invoices | Tax Exemption (zero amount invoices) |
| InvoiceStatus | InvoiceStatusType | Current status of the invoice |
| DocumentStatus | DocumentStatusType | ? |
| ResponseState | InvoiceResponseState | Commercial invoice approval state. (Approved / rejected) |
| IsProcessed | bool | Is invoice saved to source system |
| IsReceiptProcessed | bool | Is invoice receipt processed |
| Direction | InvoiceDirection | This field is used to seperate incoming and outgoing invoices |
| GIBStatusCode | int? | This field is updated when portal+ got a notification from GIB by EInvoice integrator about the status of the invoice |
| GIBStatus | string |
This field is updated when portal+ got a notification from GIB by integrator about the status of the invoice Maximum length:1000 |
| IntegratorSourceIntId | int? |
This field stores the EInvoice integrator source id that is selected to send this invoice to GIB (integrators are configured as sources in portal+) Maximum length:1000 |
| CommunicationTax | decimal? | special communication tax amount |
| CustomerId | string |
Customer account id Maximum length:60 |
| CustomerNo | string |
Customer BO Number for PMS Maximum length:20 |
| CustomerName | string * [Required] |
Name of the customer Maximum length:200 |
| CustomerTaxOffice | string * [Required] Madantory for einvoice Optional for earchive |
Tax office of the customer account. This value is required to use this account inside an invoice that have to be sent to GIB Maximum length:100 |
| CustomerTaxNo | string * [Required] |
Tax number of the customer account. This value is required to use this account inside an invoice that have to be sent to GIB Maximum length:60 |
| CustomerTaxType | TaxNumberType ? * [Required] | Customer tax number type. Optional |
| CustomerAlias | string |
gib party alias. eg: urn:mail:test@protel.com.tr Maximum length:200 |
| CustomerBranch | string |
Customer Branch information Maximum length:50 |
| CustomerWebsite | string |
website of the customer account Maximum length:255 |
| SupplierKEPAddress | string |
email of the customer account Maximum length:255 |
| CustomerEMail | string * [Required] Sendtype electronic for mandorty this field | ? |
| CustomerEMail2 | string |
second email of the customer account Maximum length:255 |
| CustomerTel | string |
Customer account phone Maximum length:60 |
| CustomerMobilePhone | string |
Customer account mobile phone Maximum length:60 |
| CustomerFax | string |
Customer account fax Maximum length:60 |
| CustomerRoom | string |
Customer room number Maximum length:10 |
| CustomerStreetName | string |
Customer street name Maximum length:300 |
| CustomerBuildingName | string |
Customer building name Maximum length:60 |
| CustomerBuildingNumber | string |
Customer building number Maximum length:60 |
| CustomerCitySubdivisionName | string * [Required] Mandatory for einvoice Optional for earchive |
Customer city or subdivision name Maximum length:60 |
| CustomerCityName | string * [Required] Mandatory for einvoice Optional for earchive |
Customer city name Maximum length:60 |
| CustomerPostalZone | string |
Customer posta code Maximum length:60 |
| CustomerCountryName | string * [Required] |
Customercountry name Maximum length:60 |
| IsGovernmentAgency | bool | IsGovernmentAgency |
| PayeeCurrencyCode | string |
Payee Currency Code For GovermentAgency Maximum length:50 |
| PayeeIBANNumber | string |
Payee IBAN Number For GovermentAgency Maximum length:50 |
| GCBNo | string |
GCB no for EExport Invoices Maximum length:100 |
| ActualExportDate | DateTime? | GCB Export Date for EExport Invoices |
| RegCode | string |
GCB RegCode for EExport Invoices Maximum length:50 |
| CustomerLangCode | string | null = unknown, eg: tr-TR for Turkish and en-US for English |
| SupplierIntId | int? | Internal supplier account id |
| SupplierId | string |
Supplier account id Maximum length:60 |
| SupplierName | string |
Name of the Supplier Maximum length:200 |
| SupplierTaxOffice | string |
Tax office of the Supplier account. This value is required to use this account inside an invoice that have to be sent to GIB Maximum length:100 |
| SupplierTaxNo | string |
Tax number of the Supplier account. This value is required to use this account inside an invoice that have to be sent to GIB Maximum length:60 |
| SupplierAlias | string | gib party alias. eg: urn:mail:test@protel.com.tr |
| SupplierTradeRegisterNo | string |
Trade Registration Number for Supplier Party. Maximum Length: 12 |
| SupplierMersisNo | string |
Mersis No for Supplier Party. Maximum Length: 16 |
| SupplierWebsite | string |
website of the Supplier account Maximum length:255 |
| SupplierEMail | string |
email of the Supplier account Maximum length:255 |
| SupplierTel | string |
Supplier account phone Maximum length:60 |
| SupplierFax | string |
Supplier account fax Maximum length:60 |
| SupplierRoom | string |
Supplier room number Maximum length:10 |
| SupplierStreetName | string |
Supplier street name Maximum length:300 |
| SupplierBuildingName | string |
Supplier building name Maximum length:60 |
| SupplierBuildingNumber | string |
Supplier building number Maximum length:60 |
| SupplierCitySubdivisionName | string |
Supplier city or subdivision name Maximum length:60 |
| SupplierCityName | string |
Supplier city name Maximum length:60 |
| SupplierPostalZone | string |
Supplier posta code Maximum length:60 |
| SupplierCountryName | string |
Supplier country name Maximum length:60 |
| Branch | string |
Used by systems like micros for store information. So, all stores can be send invoices to the same folder/source and they can be separated by this branch info. Maximum length:100 |
| SystemReference | string |
folioNo for PMS checkNo for POS ficheNo for BO Maximum length: 50 |
| ExtraFields | List< ExtraField > |
Additional Fields. Available Keys: xxx : |
| Extra1 | string |
Extra Field 1 Maximum length: 100 |
| Extra2 | string |
Extra Field 2 Maximum length: 100 |
| Extra3 | string |
Extra Field 3 Maximum length: 100 |
| Extra4 | string |
Extra Field 4 Maximum length: 100 |
| Extra5 | string |
Extra Field 5 Maximum length: 100 |
| Extra6 | string |
Extra Field 6 Maximum length: 100 |
| Extra7 | string |
Extra Field 7 Maximum length: 100 |
| Extra8 | string |
Extra Field 8 Maximum length: 100 |
| SendDate | DateTime? | Send Invoice Date |
| CreditTransId | long? | Transaction id of the credit used to send this invoice to integrator. |
| OTV1 | decimal? | 0071 = ÖTV 1. LİSTE, PETROL VE DOĞALGAZ ÜRÜNLERİNE İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| OTV2 | decimal? | 9077 = ÖTV 2.LİSTE, MOTORLU TAŞIT ARAÇLARINA İLİŞKİN ÖZEL TÜKETİM VERGİSİ (TESCİLE TABİ OLANLAR) |
| OTV3 | decimal? | 0073 = KOLALI GAZOZ, ALKOLLÜ İÇEÇEKLER VE TÜTÜN MAMÜLLERİNE İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| OTV4 | decimal? | 0074 = ÖTV 4. LİSTE, DAYANIKLI TÜKETİM VE DİĞER MALLARA İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| OTV3A | decimal? | 0075 = ALKOLLÜ İÇEÇEKLERE İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| OTV3B | decimal? | 0076 = ÖTV 3B LİSTE, TÜTÜN MAMÜLLERİNE İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| OTV3C | decimal? | 0077 = ÖTV 3C LİSTE, KOLALI GAZOZLARA İLİŞKİN ÖZEL TÜKETİM VERGİSİ |
| IsRead | bool? | Is e-invoice opened by the user |
| WithholdingTaxCode | string * [Required] If Invoice include withholdingtax, this field mandatory | ubltr1.2 extension |
| ExportCode | string * [Required] If Invoice include export, this field mandatory | ? |
| TaxExemptionReasonCode | string * [Required] If Invoice include withholdingtax, this field mandatory | ubltr1.2 extension |
| AccExemptionReasonCode | string | ubltr1.2 extension |
| EAInvoiceDeliveryType | EAInvoiceDeliveryType ? * [Required] If Invoice include withholdingtax, this field mandatory | contains delivery type if this is an e-archive invoice |
| OkcPaperNumber | string | contains OKC paper number if this is an e-archive invoice |
| OkcPaperDate | DateTime? | contains OKC paper date if this is an e-archive invoice |
| OkcSerialNumber | string | contains OKC serial number if this is an e-archive invoice |
| OkcZNumber | string | contains OKC z-number if this is an e-archive invoice |
| IsCreditCard | bool? | Is this an credit card sale |
| PrintCount | int | Invoice print/view count |
| IsAdvance | bool? | Is this an advance or not |
| IsArchived | bool | ? |
| ArchivedBy | int? | ? |
| ArchivedOn | DateTime? | ? |
| IsCancelled | bool | Used internally by e-archive invoice job processor to protect cancellation state |
| CancelDate | DateTime? | e-archive invoice cancellation date for cancelled invoices |
| CancelReason | string | Cancel reason for e-archive invoice |
| DenyType | DenyType ? | ? |
| DeliveryStreetName | string | ? |
| DeliveryCityName | string | ? |
| DeliveryCitySubdivisionName | string | ? |
| DeliveryCountryName | string | ? |
| DeliveryPostalZone | string | ? |
| IsInternetSale | bool | Is this an internet sale e-archive invoice |
| SaleWebUrl | string * [Required] If Invoice include withholdingtax, this field mandatory | Required field for internet sales in e-archive invoices. Web site address of the sale |
| PaymentMethod | string * [Required] If Invoice include withholdingtax, this field mandatory | Required field for internet sales in e-archive invoices. eg: EFT/HAVALE, KREDIKARTI,.. |
| PaymentPlatform | string * [Required] If Invoice include withholdingtax, this field mandatory | Optional field used by internet sales in e-archive invoices. eg: Paypal,.. |
| PaymentDate | DateTime? * [Required] If Invoice include withholdingtax, this field mandatory | Required field for internet sales in e-archive invoices. |
| IsCityLedger | bool | Used by PMS systems (Suite8/Opera) for e-archive invoices. True if this invoice belongs to a city ledger guest. |
| MatchingInvoiceIntId | int? | If the invoice is cancelled, this field is filled with invoice IntId. |
| ChannelCode | string | Used by pms systems to detect internet sales for e-archive invoices |
| ChannelGroupCode | string | Used by pms systems to detect internet sales for e-archive invoices |
| PaymentMeansCode | string | ? |
| RegistrationName | string | ? |
| CheckIntId | int? | Related Check Int Id |
| CheckETTNDate | List<KeyValuePair<string, DateTime>> | ? |
| ResponseComplete | ResponseStatus | ? |
| InvoiceNExts | List< InvoiceNExt > | ? |
| ReservationList | List<string> | ? |
| InvoiceLines | List< InvoiceLine > * [Required] | List of child invoice detail records |
| TaxItems | List< InvoiceTaxItem > | List of tax items |
| AllowanceItems | List< InvoiceAllowance > | ? |
| ExtData | InvoiceExt | ? |
| LineCountFromSource | int | ? |
| GIBReportId | string | ? |
| Parts | List< InvoicePart > | Invoice view parts for Invoice Html view. |
| DetailXML | string | ? |
| TaxGroups | List< TaxGroup > | Tax details by Percentage |
| IsPM | bool? |
Optional field, used bu PMS systems. True value shows "PM No" instead of "Oda No" in the invoice view. |
| PassportNo | string | Used internally by portalplus to store passport number of foreign customers for some e-archive invoices |
| PayeeVKNType | PaymentVKNType | ? |
| PayeeVKN | string | ? |
| IsReOpen | bool | ? |
| ReferenceInvoiceId | string | ? |
| CheckCount | int? | ? |
| CheckNoList | List<KeyValuePair<string, DateTime>> | ? |
