Nilvera API v1
Swagger APIGo To App
English
English
  • Overview
  • API Key Generation
  • Error Codes
  • API
    • GENERAL API
      • Company Procedures
        • Retrieve Company Information
        • Update Company Information
        • Retrieve Company Modules
      • Company Identity Information
        • Lists Company Identity Information
        • Adds New Identity Information to the Company
        • Deletes Identity Information from the Company
      • Credit
        • Returns Credit Information
      • Customers
        • Customer Lists
        • Customer Adds
        • Customer Updates
        • Customer Deletes
        • Searches the Customer List
        • Brings Customer Information
      • Currency Information
        • Brings Foreign Exchange Information
      • GIB User Information
        • Gets GIB Username and Password
        • GİB Updates Username and Password
      • Taxpayer Transactions
        • Lists E-Invoice Taxpayers
        • Searches the Taxpayer List
        • Brings Taxpayer Information
        • Brings Taxpayer Information in List
        • Queries with TIN
        • Queries by Title
        • Taxpayer List is Returned as a Zip File
      • Mail Transactions
        • Brings up Mail Settings
        • Changes Whatsapp Feature
        • Changes Mail Feature
        • Changes SMS Feature
      • Stocks
        • Lists Stocks
        • Stock Inserts
        • Stock Updates
        • Brings Stock
        • Searches the Stock List
        • Deletes Stock
    • E-INVOICE API
      • Sending E-Invoice
        • Send the Invoice as a Model
        • Preview the Invoice to be Sent as a Model
        • Send the Invoice as XML
        • Preview the Invoice to be Sent as XML
        • Send the Invoice as Base64 String
        • Preview the Invoice to be Sent as Base64 String
        • Retrieve the XML of the Previewed Invoice
        • Download the PDF of the Previewed Invoice
      • Draft Invoices
        • List Draft Invoices
        • Delete Draft Invoices
        • Retrieve the HTML of the Draft
        • Retrieve the PDF of the Draft
        • Retrieve the XML of the Draft
        • Retrieve the Model of the Draft
        • Assign Tags to Draft Invoice
        • Retrieve Tag Information of the Draft Invoice
        • Export Drafts in Bulk
        • Assign New Status to Drafts
        • Approve and Send the Draft
        • Edit and Send the Draft
        • Create Draft
        • Create Bulk Draft Invoices
        • Retrieve WhatsApp Transaction History
        • Send Draft Invoice via WhatsApp
        • Assign Custom Code to Draft Invoice
      • Notification Settings
        • List Sales Invoice Notification Settings
        • Create Sales Invoice Notification Rule
        • Update Sales Invoice Notification
        • Delete Sales Invoice Notification Setting
        • Retrieve Sales Invoice Notification Rule
        • List Purchase Invoice Notification Settings
        • Create Purchase Invoice Notification Rule
        • Update Purchase Invoice Notification
        • Delete Purchase Invoice Notification Setting
        • Retrieve Purchase Invoice Notification Rule
      • Old Invoices
        • List Old Invoices
        • Upload Old Invoices
        • Retrieve the HTML of the Old Invoice
        • Retrieve the PDF of the Old Invoice
        • Retrieve the XML of the Old Invoice
        • Export Old Invoices in Bulk
        • Assign New Status to Old Invoices
      • Incoming Invoices
        • List Incoming Invoices
        • Retrieve the HTML of the Invoice
        • Retrieve the PDF of the Invoice
        • Retrieve the XML of the Invoice
        • Assign Tags to Invoice
        • Retrieve Tag Information of the Invoice
        • Retrieve Transaction History
        • Retrieve Details
        • List Invoice Attachments
        • Retrieve Despatch Note Information
        • Retrieve Email Transaction History
        • Retrieve WhatsApp Transaction History
        • Retrieve SMS Transaction History
        • Retrieve Email Activities
        • Export Invoices in Bulk
        • Assign New Status to Invoices
        • Send the Invoice via Email
        • Send the Invoice via WhatsApp
        • Send the Invoice via SMS
        • Verify the Invoice with GİB
        • Retrieve Envelope Information with ETTN Number for the Invoice
        • Save as Draft
        • Respond to the Invoice
        • Retrieve Rejection Response of the Invoice
        • Save the Incoming Invoice as a Return Invoice
        • Retrieve Status Information of the Incoming Invoice
        • Assign Custom Code to Invoice
      • Outgoing Invoices
        • Lists Outgoing Invoices
        • Get the HTML of the Invoice
        • Get the PDF of the Invoice
        • Get the XML of the Invoice
        • Assigns Tags To The Invoice
        • It Fetches The Invoice Label Information
        • Retrieve Transaction History
        • Brings Details
        • Lists the Attachments of the Invoice
        • Retrieves the Despatch Note Information
        • Retrieves Email Transaction History
        • Retrieves WhatsApp Transaction History
        • Retrieves SMS Transaction History
        • Retrieves Email Activities
        • Exports Invoices in Bulk
        • Sets New Status to Invoices
        • Sends the Invoice via Email
        • Sends the Invoice via WhatsApp
        • Sends the Invoice via SMS
        • Checks the Invoice from GTB
        • Checks the Invoice from GİB
        • Retrieves Envelope Information with the ETTN Number of the Invoice
        • Save as Draft
        • Creates Drafts for Invoices in Bulk
        • Retrieves the Rejection Response of the Invoice
        • Retrieves the Status Information of the Outgoing Invoice
        • Assigns a Custom Code to the Invoice
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Statistics
        • Returns Outgoing Invoice Statistics
        • Returns Incoming Invoice Statistics
        • Returns the Last 10 Records of Outgoing Invoices
        • Returns the Last 10 Records of Incoming Invoices
      • Tags
        • Get Tag List
        • Create Tag
        • Update Tag
        • Delete Tag
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Delete Template
        • Get Template
      • File Upload
        • Load as XML
        • Uploads SGK Invoice as PDF
    • E-ARCHIVE INVOICE API
      • Sending an Invoice
        • Sends Invoice as Model
        • Previews the Invoice to be Sent as a Model
        • Sends Invoice as Xml
        • Previews the Invoice to be Sent as XML
        • Sends Invoice as Base64String
        • Previews the Invoice to be Sent as Base64
        • Gets the Xml of the Previewed Invoice
        • Downloads Previewed Invoice as PDF
        • Sends Report of Invoices.
      • Draft Invoices
        • Lists Draft Invoices
        • Deletes Draft Invoices
        • Bring HTML of the Draft
        • Bring PDF of the Draft
        • Bring XML of the Draft
        • Bring Model of the Draft
        • Tag Assignment to Draft Invoice
        • Gets the Tag Information of the Draft Invoice
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Creates Bulk Draft Invoice
        • Brings Whatsapp Transaction History
        • Sends Draft Invoice via Whatsapp
        • A Special Code is Assigned to the Draft Invoice
      • Incoming E-Archive Invoices
      • Notification Settings
        • Lists Notification Rules
        • Creates Notification Rule
        • Updates Notification Rule
        • Deletes Notification Rule
        • Bring the Notification Rule
      • E-Archive Invoices
        • Lists Invoices
        • Get the HTML of the Invoice
        • Get the PDF of the Invoice
        • Get the XML of the Invoice
        • Tag Assignment to the Invoice
        • Gets Tag Information of the Invoice
        • Gets Transaction History
        • Brings Details
        • Lists Document Attachments
        • Returns Delivery Note Information
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets SMS Transaction History
        • Gets Email Activities
        • Exports Invoices in Bulk
        • Assigns New Status to Invoices
        • Sends the Invoice via Email
        • Sends the Invoice via Whatsapp
        • Sends Invoice via SMS
        • Saves as Draft
        • Bulk Drafts Outgoing Invoices
        • Cancels the Invoice
        • Undoes Invoice Cancellation
        • Returns the Status Information of the Invoice
        • A Special Code is Assigned to the Invoice
      • Old Invoices
        • Lists Old Invoices
        • Upload Old Invoices
        • Get the HTML of the Old Invoice
        • Get the PDF of the Old Invoice
        • Get the XML of the Old Invoice
        • Bulk Exports Old Invoices
        • Assigns New Status to Old Invoices
      • Reports
        • Brings Reports
        • Returns the List to Create a Report
        • Gets Report Xml
        • Lists the Documents in the Sent Report
        • Report Returns Transaction History
        • Queries Report Status from GİB
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Downloads Template
      • Statistics
        • Gets Statistics of Invoices
        • Gets the last 10 invoices
      • Tags
        • Gets Tag List
        • Creates Tag
        • Tag Updated
        • Tag Deleted
      • File Upload
        • Upload as XML File
    • E-DESPATCH API
      • Sending Despatch
        • Sends the Despatch as a Model
        • It Sends the Despatch as XML.
        • Sends the Despatch as Base64String
        • Previews the Despatch to be Sent
        • Returns the XML of the Previewed Despatch
      • Draft Despatch
        • Lists Draft Despatch
        • Deletes Draft Despatch
        • HTML of the draft is fetched
        • PDF of the draft is brought
        • XML of the draft is fetched
        • The Model of the Draft is Fetched
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Brings Whatsapp Transaction History
        • Sends Draft Despatch via Whatsapp
      • Outgoing Despatch
        • Lists Outgoing Despatch
        • Get Despatch HTML
        • Get HTML of Despatch Response
        • Get Despatch PDF
        • Get PDF of Despatch Response
        • Get XML of Despatch
        • Get XML of Despatch Response
        • Gets Transaction History
        • Brings Details
        • Lists Document Attachments
        • Returns the Status Information of the Outgoing Despatch
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets Email Activities
        • Exports Despatch in Bulk
        • Bulk Exports Despatch Responses
        • Assigns a New Status to Despatch
        • Sends the Despatch via e-mail
        • Sends the Despatch via Whatsapp
        • Controls the Despath from the GIB
        • Saves as Draft
      • Incoming Despatch
        • Lists Incoming Despatch
        • Get the HTML of the Despatch
        • Get HTML of Despatch Response
        • Get PDF of Despatch
        • Get PDF of Despatch Response
        • Get XML of Despatch
        • Get XML of Despatch Response
        • Gets Transaction History
        • Brings Details
        • Lists Document Attachments
        • Returns the Status Information of the Incoming Despatch
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets Email Activities
        • Exports Despatch in Bulk
        • Bulk Exports Despatch Responses
        • Assigns a New Status to Despatch
        • Sends the Despatch via e-mail
        • Sends the Despatch via Whatsapp
        • Controls the Despatch from the GİB
        • Saves as Draft
        • Creates a Response to the Despatch
        • Brings Despatch Items
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Gets Template
      • Statistics
        • Returns Outgoing Despatch Statistics
        • Returns Incoming Despatch Statistics
      • File Upload
        • Loads as XML
    • E-PRODUCER API
      • Sending E-Producer Receipt
        • Sends Receipt as Model
        • Sends the receipt as XML
        • Previews the Receipt to Send
        • Gets XML of Previewed Receipt
        • Sends Report
      • Draft Producer
        • Lists Draft Producer
        • Deletes Draft Producer
        • Get HTML of Draft
        • Get PDF of Draft
        • Get XML of Draft
        • Get Model of Draft
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Brings Whatsapp Transaction History
        • Sends Draft Producer Via Whatsapp
      • Producer
        • Lists Producers
        • Get Producer HTML
        • Get Producer PDF
        • Get Producer XML
        • Gets Transaction History
        • Brings Details
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets Email Activities
        • Bulk Exports Producers
        • Assigns New Status to Producers
        • Sends Producer via Email
        • Sends Producer Via Whatsapp
        • Saves as Draft
        • Cancel Producer
        • Undoes Producer Cancellation
      • Reports
        • Brings Reports
        • Returns the List to Create a Report
        • Gets Report XML
        • Lists the Documents in the Sent Report
        • Report Returns Transaction History
        • Queries Report Status from GİB
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Gets Template
      • Statistics
        • Brings Statistics
      • File Upload
        • Uploads as XML
    • E-INSURANCE API
      • Sending E-Insurance Document
        • Sends the document as Model
        • Previews the document to Send
        • Sends the document as XML
        • Previews the document to Send
        • Sends Document as Base64
        • Previews the document to Send
        • Gets XML of Previewed Document
        • Sends Report
      • Notification Settings
        • Lists Document Notification Rules
        • Creates Document Notification Rule
        • Updates Document Notification Rule
        • Deletes Document Notification Rule
        • Gets Document Notification Rule
      • Draft Insurances
        • Lists Draft Insurance
        • Deletes Draft Insurance
        • Get HTML of Draft
        • Get PDF of Draft
        • Get XML of Draft
        • Get Model of Draft
        • Assigns Tag to Draft
        • Gets Tag Information of Draft
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Creates Bulk Draft
        • Brings Whatsapp Transaction History
        • Sends Draft Insurance Via Whatsapp
        • Assigns Custom Code to Draft Document
      • Insurance
        • Lists Insurances
        • Get Insurance HTML
        • Get Insurance PDF
        • Get Insurance XML
        • Assigns Tag to Insurance
        • Gets Tag Information of Insurance
        • Gets Transaction History
        • Brings Details
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets SMS Transaction History
        • Gets Email Activities
        • Bulk Exports Insurances
        • Assigns New Status to Insurances
        • Sends Insurance via Email
        • Sends Insurance Via Whatsapp
        • Sends Document via SMS
        • Saves as Draft
        • Cancel Insurance
        • Undoes Insurance Cancellation
        • Gets Status Information of Insurance
        • Assigns Special Code to Insurance
      • Reports
        • Brings Reports
        • Returns the List to Create a Report
        • Gets Report XML
        • Lists the Documents in the Sent Report
        • Report Returns Transaction History
        • Queries Report Status from GİB
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Statistics
        • Brings Statistics
        • Brings Last 10 Insurances
      • Tags
        • Gets Tag List
        • Creates Tag
        • Updates Tag
        • Deletes Tag
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Gets Template
      • File Upload
        • Uploads as XML
    • E-VOUCHER API
      • Sending E-Voucher
        • Sends Voucher as Model
        • Sends Voucher as XML
        • Previews the Voucher to Send
        • Gets XML of Previewed Voucher
        • Sends Report
      • Draft Vouchers
        • Lists Draft Voucher
        • Deletes Draft Voucher
        • Get HTML of Draft
        • Get PDF of Draft
        • Get PDF of Draft
        • Get Model of Draft
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Creates Bulk Draft
        • Brings Whatsapp Transaction History
        • Sends Draft Voucher Via Whatsapp
      • Vouchers
        • Lists Vouchers
        • Get Voucher HTML
        • Get Voucher PDF
        • Get Voucher XML
        • Gets Transaction History
        • Brings Details
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets Email Activities
        • Bulk Exports Vouchers
        • Assigns New Status to Vouchers
        • Sends Voucher via Email
        • Sends Voucher Via Whatsapp
        • Sends Voucher Via SMS
        • Saves as Draft
        • Cancels Voucher
        • Undoes Voucher Cancellation
        • Returns Status Information of the Voucher
      • Reports
        • Brings Reports
        • Returns the List to Create a Report
        • Gets Report XML
        • Lists the Vouchers in the Sent Report
        • Report Returns Transaction History
        • Queries Report Status from GİB
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Gets Template
      • Statistics
        • Lists the Last 10 Issued Voucher
        • Brings Statistics
      • File Upload
        • Loads as XML
    • E-BILL API
      • Sending E-Bill
        • Sends Bill as Model
        • Previews the bill to Send
        • Sends Bill as XML
        • Previews the bill to Send
        • Sends Bill as Base64
        • Previews the bill to Send
        • Gets XML of Previewed Bill
        • Sends Report
      • Draft Bills
        • Lists Draft Bill
        • Deletes Draft Bill
        • Get HTML of Draft
        • Get PDF of Draft
        • Get XML of Draft
        • Get Model of Draft
        • Assigns Tag to Draft
        • Gets Tag Information of the Draft
        • Bulk Exports Drafts
        • Assigns New Status to Drafts
        • Approves and Sends the Draft
        • Edit and Send the Draft
        • Creates Draft
        • Creates Bulk Drafts
        • Gets WhatsApp Transaction History
        • Sends Draft via WhatsApp
        • Assigns Special Code to Draft
      • Notification Settings
        • Lists Document Notification Rules
        • Creates Document Notification Rule
        • Updates Document Notification Rule
        • Deletes Document Notification Rule
        • Gets Document Notification Rule
      • Bills
        • Lists Bills
        • Get HTML of Bill
        • Get PDF of Bill
        • Get XML of Bill
        • Gets Transaction History
        • Brings Details
        • Brings Mail Transaction History
        • Brings Whatsapp Transaction History
        • Gets Email Activities
        • Bulk Exports Bills
        • Assigns New Status to Bills
        • Sends Bill via Email
        • Sends Bill Via Whatsapp
        • Saves as Draft
        • Cancel Bill
        • Undoes Bill Cancellation
      • Reports
        • Brings Reports
        • Returns the List to Create a Report
        • Gets Report XML
        • Lists the Documents in the Sent Report
        • Report Returns Transaction History
        • Queries Report Status from GİB
      • Series
        • Lists Series
        • Creates New Series
        • Updates Series
        • Brings Details of the Series
      • Templates
        • Lists Templates
        • Creates Template
        • Updates Template
        • Gets the Details of the Template
        • Deletes Template
        • Gets Template
      • Tags
        • Gets Tag List
        • Creates Tag
        • Updates Tag
        • Deletes Tag
      • Statistics
        • Brings Last 10 Bills
        • Brings Statistics
      • File Upload
        • Uploads as XML
    • E-STORAGE API
      • Ledgers
        • Ledger List
        • Downloads the Ledgers
        • Previews the Ledger
        • Upload Ledger
        • Get Statistics of Ledgers
    • E-LEDGER API
      • Accountant Information
        • Accountant Creates
        • Brings Accountants
        • Accountant Deletes
        • Updates Accountant
      • Ledger Settings
        • Creates or Updates Settings
        • Get Settings
      • Company ERP Information
        • Returns Company Ledger Queries
        • Brings Defined ERP Parameters to the Company
        • Brings the Defined ERP List to the Company
      • Ledgers
        • Deletes the Ledgers
        • Brings the Ledgers
        • Downloads the Ledgers
        • Downloads the Ledgers for the Relevant Year and Month
        • Downloads Ledgers in Bulk
        • Sets Ledger Status to Success
        • Uploads Old Ledgers
        • Gets Ledger Numbers for the Relevant Year
        • Deletes Uploaded Old Ledgers
        • Downloads all Ledgers in the Relevant Year
        • Downloads CSV File in Related Year and Month
        • Downloads the Ledgers of Companies and Branches for the Relevant Year and Month
        • Displays the Ledger
        • Gets Ledger Details
        • Schema/Schematron Control is Performed on the Ledger
        • Gets Ledger History
        • Gets Total Debit and Credit Information of Ledgers by Year
        • Checks the Accuracy of the Ledger
      • ERP
        • Gets ERP List
      • GİB
        • Journal and G/L Certificates are Sent to GIB
        • Brings GIB Approved Certificates
        • Sends the Ledger Report to the GİB
        • Queries the Status of the Ledger Report
        • Sends the Ledgers that are Faulty or Need to be Sent Again
        • Returns the Status of the Ledgers in the Relevant Month
      • Settings
        • Ledger Settings are Created/Updated
        • Gets Ledger Settings
      • Signing
        • Signs All Ledgers in the Relevant Period with Company Signature (HSM)
        • Returns the UUIDs of All Ledgers in the Relevant Period
      • Statistics
        • Gets Statistics
        • Gets Last 10 Ledger Records
      • File Upload
        • A Ledger is Created by Taking the Zip .csv File
        • Brings Uploaded Ledgers
        • Creates a Ledger by Taking the Base64 String Value of a Zip .csv File
        • GIB Approved Certificates of Manually Uploaded Ledgers Are Uploaded
        • Ledger Errors Are Introduced
        • Returns the Year and Period Information of the Last Ledger
    • E-REPORT API
      • Accounting Report
        • Lists Reports
        • Creates a Report
        • Downloads Report
        • Report Template Lists
        • Creates Accounting Report Template
        • Updates Report Template
        • Deletes Report Template
        • Report Template Columns Lists
        • Gets Report Template Columns
  • NİLVERA MODEL
    • EInvoice
      • InvoiceInfo
      • CompanyInfo
      • CustomerInfo
      • BuyerCustomerInfo
      • ExportCustomerInfo
      • TaxFreeInfo
      • InvoiceLines
      • Notes
      • CustomerAlias
    • ArchiveInvoice
      • InvoiceInfo
      • CompanyInfo
      • CustomerInfo
      • InvoiceLines
      • Notes
    • EDespatch
      • DespatchInfo
      • DespatchSupplierInfo
      • DeliveryCustomerInfo
      • BuyerCustomerInfo
      • SellerSupplierInfo
      • OriginatorCustomerInfo
      • Notes
      • DespatchLines
      • ShipmentDetail
      • AdditionalDocumentReference
      • OrderReference
      • CustomerAlias
    • EDespatchAnswer
      • DespatchInfo
      • DespatchSupplierInfo
      • DeliveryCustomerInfo
      • BuyerCustomerInfo
      • SellerSupplierInfo
      • ShipmentDetail
      • ReceiptLines
      • DespatchDocumentReference
      • Notes
      • DocumentReference
      • AdditionalDocumentReference
    • Producer
      • ProducerInfo
      • CompanyInfo
      • CustomerInfo
      • ProducerLines
      • Notes
    • Voucher
      • VoucherInfo
      • CompanyInfo
      • CustomerInfo
      • VoucherLines
      • Notes
    • Bill
      • BillInfo
      • CompanyInfo
      • CustomerInfo
      • SellerInfo
      • BillLines
      • Notes
    • ELedger
      • Eledger Properties
      • Accounting
      • DownloadLedger
  • GİB CODE LISTS
Powered by GitBook
On this page
  • UUID
  • TemplateUUID
  • TemplateBase64String
  • InvoiceType
  • InvoiceSerieOrNumber
  • IssueDate
  • CurrencyCode
  • ExchangeRate
  • InvoiceProfile
  • DespatchDocumentReference
  • OrderReference
  • OrderReferenceDocument
  • AdditionalDocumentReferences
  • TaxExemptionReasonInfo
  • PaymentTermsInfo
  • PaymentMeansInfo
  • OKCInfo
  • ReturnInvoiceInfo
  • AccountingCost
  • InvoicePeriod
  • SGKInfo
  1. NİLVERA MODEL
  2. EInvoice

InvoiceInfo

This object is the object that holds the invoice headers. Details about the object are described below.

UUID

It is the unique number in the Guid data type that will be used to track the invoice.

EInvoice.InvoiceInfo.UUID = 'b8787efb-639d-4efc-85b5-953bf1dbaac0';

If the field is sent empty, a new UUID will be added to the invoice by the system.

TemplateUUID

This field is used for the UUID of the XSLT that will be added to the invoice. XSLT of the UUID is added to the invoice.

EInvoice.InvoiceInfo.TemplateUUID = '94e8b735-1361-4d6f-a4a6-3745b62239c8';
  • If the TemplateUUID field is full and the TemplateBase64String field is empty, the design of the entered TemplateUUID information will be added to the invoice.

  • If the TemplateBase64String field is full, TemplateBase64String information will be added as the design of the invoice, regardless of the TemplateUUID field.

  • If the TemplateUUID and TemplateBase64String fields are left blank, the default design will be added to the invoice.

TemplateBase64String

Base64 of the design to be added to the invoice is added here.

  • If the TemplateUUID field is full and the TemplateBase64String field is empty, the design of the entered TemplateUUID information will be added to the invoice.

  • If the TemplateBase64String field is full, TemplateBase64String information will be added as the design of the invoice, regardless of the TemplateUUID field.

  • If the TemplateUUID and TemplateBase64String fields are left blank, the default design will be added to the invoice.

InvoiceType

It is an object of enum data type. It can take the following values. The selection should be made according to the invoice type.

public enum InvoiceType
{
        SATIS = 0,
        IADE = 1,
        ISTISNA = 2,
        TEVKIFAT = 3,
        IHRACKAYITLI = 4,
        IPTAL = 5,
        OZELMATRAH = 6,
        SGK = 7,
        TEVKIFATIADE = 8,
        KOMISYONCU = 9,
        HKSSATIS = 10,
        HKSKOMISYONCU = 11,
        KONAKLAMAVERGISI = 12
 }
EInvoice.InvoiceInfo.InvoiceType = 0;

In case the invoice type is "ISTISNA"; The VAT exemption reason must be entered in the "KDVExemptionReasonCode" field in the TaxExemptionReasonInfo object. The values it can take are stated under VAT Exemption Reasons in the code lists section.

If the invoice type is "IHRACKAYITLI"; The Export registered invoice reason must be entered in the "KDVExemptionReasonCode" field in the TaxExemptionReasonInfo object. The possible values are specified under Export Registered Invoice Reasons in the code lists section.

InvoiceSerieOrNumber

You can enter the 16-digit e-Invoice number and 3-digit serial information in this field. If you enter a 16-digit invoice number, no action will be taken and the value you entered will be determined as the invoice number. If you enter a 3-digit series, a number is generated based on this series defined on the portal.

//Manual Invoice Number
EInvoice.InvoiceInfo.InvoiceSerieOrNumber = "EFT2022000000001";

//Series Information
EInvoice.InvoiceInfo.InvoiceSerieOrNumber = "EFT";

The next number is automatically assigned to the EFT series registered in the portal.

IssueDate

Invoice date and time are entered in this field.

EInvoice.InvoiceInfo.IssueDate = "2022-01-23T10:20:39.846Z";

CurrencyCode

This field is where the currency of the invoice will be entered. The possible values are specified under Currency Codes in the code lists section.

EInvoice.InvoiceInfo.CurrencyCode = "TRY";

ExchangeRate

This field is where the exchange rate will be entered when the invoice is issued in a currency other than Turkish Lira. Exchange rate information will appear on the invoice.

InvoiceProfile

It is an object of enum data type. It can take the following values. This is the field where the scenario of the e-invoice will be specified.

public enum InvoiceProfile 
{ 
        TEMELFATURA = 1,
        TICARIFATURA = 2,
        IHRACAT = 3,
        YOLCUBERABERFATURA = 4,
        EARSIVFATURA = 5,
        KAMU = 6,
        HKS = 7
}

The invoice is automatically accepted without waiting for a response from the recipient. In case of rejection, the buyer must issue a return invoice.

In this invoice scenario, the buyer can return an ACCEPT/REJECT response to the invoice within 8 days. If there is no response from the buyer within 8 days, the invoice is automatically accepted.

This is the scenario to be used for goods export invoices annexed to the Customs Declaration. The invoice is automatically transmitted to GTB. If accepted, the 23-digit reference number is sent to the system by GTB.

This is the mandatory scenario to be used for E-Archive invoices.

This is the scenario that should be used for e-Invoices to be issued to Public Institutions.

EInvoice.InvoiceInfo.InvoiceProfile = 2;

DespatchDocumentReference

This field is where the delivery note information of the invoice can be entered. More than one delivery note information can be entered.

public class KeyValue
{
  //Despatch date
  public DateTime IssueDate { get; set; }

  //Despatchnumber
  public string Value { get; set; }
}

OrderReference

This field is where order information for the invoice can be entered.

public class KeyValue
{
  //Order date
  public DateTime IssueDate { get; set; }

  //Order number
  public string Value { get; set; }
}

OrderReferenceDocument

This field is where the order document information for the invoice can be entered.

public class AdditionalDocumentReferenceDto
{
  public string ID { get; set; }
  public DateTime? IssueDate { get; set; }
  public string DocumentType { get; set; }
  public string DocumentTypeCode { get; set; }
  public AttachmentDto Attachment { get; set; }
}

public class AttachmentDto
{
    public string Base64Data { get; set; }
    public string MimeCode { get; set; }
    public string FileName { get; set; }
}

ID: The value of the added file or other information can be entered here.

IssueDate: The date of the attached document. (Note: It can be entered as the invoice date even if it is not used as a document but only as a value entry.)

DocumentType: The type or fixed value of the added document can be written in free text format.

DocumentTypeCode: The type or fixed value of the added document can be written as free text.

Attachment: If a file is to be entered, the file can be entered into this field.

  • Base64Data: The Base64 encoded version of the added file is entered here.

  • MimeCode: The MimeCode value of the added file is entered here. (Example: image/png)

  • FileName: The name of the added file can be entered here.

Only files of type 'doc, docx, ppt, pptx, pdf, jpg, jpeg, png' can be uploaded.

AdditionalDocumentReferences

Only files of type 'doc, docx, ppt, pptx, pdf, jpg, jpeg, png' can be uploaded.

public class AdditionalDocumentReferenceDto
{
  public string ID { get; set; }
  public DateTime? IssueDate { get; set; }
  public string DocumentType { get; set; }
  public string DocumentTypeCode { get; set; }
  public AttachmentDto Attachment { get; set; }
}

public class AttachmentDto
{
    public string Base64Data { get; set; }
    public string MimeCode { get; set; }
    public string FileName { get; set; }
}

ID: The value of the added file or other information can be entered here.

IssueDate: The date of the added document. (Note: If not specifically a document, it can also be entered as the invoice date.)

DocumentType: The type of the added document or fixed value can be written as free text.

DocumentTypeCode: The type or fixed value of the added document can be written as free text.

Attachment: If a file is to be entered, the file can be entered into this field.

  • Base64Data: The Base64 encoded version of the added file is entered here.

  • MimeCode: The MimeCode value of the added file is entered here. (Example: image/png)

  • FileName: The name of the added file can be entered here.

Only files of type 'doc, docx, ppt, pptx, pdf, jpg, jpeg, png' can be uploaded.

TaxExemptionReasonInfo

This field is where you can enter the reasons for tax exemptions for 0% VAT or Special Consumption Tax (ÖTV) found on the invoice. The possible values are listed under the "Tax Exemption Reasons" section in the code lists.

public class TaxExemptionReasonInfoDto
{
    public string KDVExemptionReasonCode { get; set; }
    public string OTVExemptionReasonCode { get; set; }
}
EInvoice.InvoiceInfo.TaxExemptionReasonInfo = {
    KDVExemptionReasonCode: "351",
    OTVExemptionReasonCode: "151"
};

PaymentTermsInfo

This is the field where payment terms information will be entered.

public class PaymentTermsDto
{
    public decimal Percent { get; set; }
    public decimal Amount { get; set; }
    public string Note { get; set; }
}

Percent: The penalty rate to be applied in case of late payment is entered numerically.

Amount: The payment amount can be entered numerically.

Note: A free-text description can be entered regarding the payment terms.

PaymentMeansInfo

This is the field where payment method information will be entered.

public class PaymentMeansDto
{
    public string Code { get; set; }
    public string ChannelCode { get; set; }
    public DateTime DueDate { get; set; }
    public string PayeeFinancialAccountID { get; set; }
    public string Note { get; set; }
}

Code: The code for the payment method is entered here. Possible values are specified under the "Payment Method Codes" section in the code lists.

ChannelCode: This is the field where the payment channel code will be entered. Possible values are specified under the "Payment Method Codes" section in the code lists.

DueDate: The deadline for payment is entered in the year-month-day format

PayeeFinancialAccountID: The account to which payment will be made is entered here.

Note: Comments related to the payment can be entered as free text.

OKCInfo

This is the field where information about the payment recording device and receipt will be entered.

public class OKCInfoDto
{
    public string ID { get; set; }
    public DateTime IssueDate { get; set; }
    public string Time { get; set; }
    public string ZNo { get; set; }
    public string EndPointID { get; set; }
    public string DocumentDescription { get; set; }
}

ID: The receipt number is entered.

IssueDate: The receipt date is entered.

Time: The receipt time is entered.

ZNo: The Z Report number is entered.

EndPointID: The ÖKC serial number is entered.

DocumentDescription: The receipt type is entered. Possible values are specified under the "POS Receipt Types" section in the code lists.

ReturnInvoiceInfo

This is the field where information about returned invoices can be entered. Multiple entries can be made.

public class ReturnInvoiceInfoDto
{
    public string InvoiceNumber { get; set; }
    public DateTime IssueDate { get; set; }
}
EInvoice.InvoiceInfo.ReturnInvoiceInfo = [
    { InvoiceNumber:"EFT0000000000001", IssueDate: "2022-03-05" },
    { InvoiceNumber:"EFT0000000000002", IssueDate: "2022-03-06" },
];

AccountingCost

This is the field where the type of invoice is entered if it is related to the Social Security Institution (SGK). Possible values are specified under the "SGK Invoice Types" section in the code lists.

EInvoice.InvoiceInfo.AccountingCost = "SAGLIK_MED";

InvoicePeriod

If the type of invoice is related to the Social Security Institution (SGK), this is the field where the 'Period Start and End Dates' will be entered.

public class InvoicePeriodDto
{
     public DateTime StartDate { get; set; }
     public DateTime StartTime { get; set; }
     public DateTime EndDate { get; set; }
     public DateTime EndTime { get; set; }
}

SGKInfo

If the type of invoice is related to the Social Security Institution (SGK), this is the field where the 'SGK Company Name, Document Number, and SGK Company Code' will be entered.

public class SGKInfoDto
{
     public string RegisterName { get; set; }
     public string DocumentNumber { get; set; }
     public string RegisterCode { get; set; }
}

RegisterName: The SGK company name is entered.

DocumentNumber: The document number is entered.

RegisterCode: The SGK company code is entered.

PreviousEInvoiceNextCompanyInfo

Last updated 1 year ago