szamlazz-hu-sdk
1.6.0
dotnet add package szamlazz-hu-sdk --version 1.6.0
NuGet\Install-Package szamlazz-hu-sdk -Version 1.6.0
<PackageReference Include="szamlazz-hu-sdk" Version="1.6.0" />
paket add szamlazz-hu-sdk --version 1.6.0
#r "nuget: szamlazz-hu-sdk, 1.6.0"
// Install szamlazz-hu-sdk as a Cake Addin #addin nuget:?package=szamlazz-hu-sdk&version=1.6.0 // Install szamlazz-hu-sdk as a Cake Tool #tool nuget:?package=szamlazz-hu-sdk&version=1.6.0
.Net Core SDK for Számlázz.hu
Minimal working example
var request = new CreateInvoiceRequest();
request.AuthenticationData.ApiKey = "<YOUR AGENT KEY>";
request.Seller.BankName = "Our Bank";
request.Seller.BankAccount = "11111111-22222222-33333333";
request.Customer.Name = "Good Friend Inc.";
request.Customer.CustomerAddress.PostalCode = "1132";
request.Customer.CustomerAddress.City = "Budapest";
request.Customer.CustomerAddress.StreetAddress = "Tárnoki út 23.";
request.Customer.TaxNumber = "12345678-1-42";
request.Items = new List<InvoiceItem> {
new InvoiceItem {
Name = "Something we sell",
Quantity = 1,
UnitOfQuantity = "piece",
UnitPrice = 1000,
VatRate = "EU",
NetPrice = 1000,
VatAmount = 0,
GrossAmount = 1000
}
};
var api = new SzamlazzHuApi();
var response = await api.CreateInvoice(request);
//Optionally write invoice PDF to the disk
File.WriteAllBytes("invoice.pdf", response.InvoicePdf);
Query taxpayers
This is used to query the validity of a VAT number and to get additional information about the taxpayer. The data is from the Online Invoice Platform of NAV, the Hungarian National Tax and Customs Administration.
Request building
The API endpoint can be used through the SzamlazzHuApi.QueryTaxpayer
method, which requires a QueryTaxpayerRequest
object as parameter. The request object contains authentication data, and a core tax nuber.
var request = new QueryTaxpayerRequest();
request.AuthenticationData.ApiKey = "<YOUR AGENT KEY>";
request.TaxpayerId = "<CORE TAX NUMBER (FIRST 8 DIGIT OF THE VAT NUMBER)>"
var api = new SzamlazzHuApi();
var response = await api.QueryTaxpayer(request);
Response
The response object contains information about the technical result of the query and optionally details about the taxpayer. Additional data about the holder of the VAT number is only presented if:
- The request was successful (
response.Success == true
) - There is a valid taxpayer on the given core tax number. (
response.TaxpayerValid == true
)
In other cases response.Taxpayer
can be null
public class QueryTaxpayerResponse
{
// True, if the query was successful and there were no technical error in communication
public bool Success { get; set; }
// Contains error code about request. It is -1, if the query was successful
public int ErrorCode { get; set; }
// Contains error message. It is null if query was successful
public string ErrorMessage { get; set; }
// Holds information about the validity of the VAT number
public bool TaxpayerValid { get; set; }
// Contains everything about the holder of the queried VAT number. It can be null in case the TaxpayerValid is false
public Taxpayer Taxpayer { get; set; }
}
Taxpayer entity
This entity holds all of the data, which can be found in the NAV database. It has required and optional properties, which is based on the NAV API definition. For further information please check the API definition of NAV Online Invoicing.
public class Taxpayer
{
// Contains the legal name of the taxpayer
public string TaxpayerName { get; set; }
// Contains the short name of the taxpayer, which can be null
public string TaxpayerShortName { get; set; }
// Contains tax number of the taxpayer
public TaxNumber TaxNumberDetail { get; set; }
// Contains tax number of the VAT group, if taxpayer has group membership
public TaxNumber VatGroupMembership { get; set; }
// Contains the incorporation type of the taxpayer
public string Incorporation { get; set; }
// Contains a list of the taxpayer addresses. This can be empty list
public List<TaxpayerAddressItem> AddressList { get; set; }
}
TaxNumber entity
This entity contains a tax number. Based on the NAV API definition, the TaxpayerId
is the only mandatory part of this entity. The other properties are just optional, don't take part of the identification.
public class TaxNumber
{
// This contains the core tax number (XXXXXXXX)-X-XX
public string TaxpayerId { get; set; }
// This contains the VAT code, it can be null if it is not presented (eg. group VAT number) XXXXXXXX-(X)-XX
public string VatCode { get; set; }
// This contains the country code, it can be null if it is not presented (eg. group VAT number) XXXXXXXX-X-(XX)
public string CountryCode { get; set; }
}
TaxpayerAddressItem entity
This entity contains an address and also holds information about the type of the address. Address types can be found in NAV documentation.
public class TaxpayerAddressItem
{
// This holds information about the type of the address (eg. HQ, SITE, etc.). See NAV documentation about the possible codes.
public string AddressType { get; set; }
// This contains the address
public Address Address { get; set; }
}
Pull Requests are Welcome!
If you are missing something please open an issue, or send a pull request! Every contribution is welcome 😃
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- NewtonSoft.JSON (>= 13.0.3)
- Scriban (>= 5.9.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.6.0 | 522 | 2/5/2024 |
1.5.2 | 337 | 9/29/2023 |
1.5.1 | 122 | 9/28/2023 |
1.4.2 | 138 | 9/28/2023 |
1.4.1 | 478 | 4/5/2023 |
1.4.0 | 514 | 1/23/2023 |
1.3.4 | 360 | 1/23/2023 |
1.3.3 | 967 | 8/1/2022 |
1.3.2 | 409 | 7/27/2022 |
1.3.1 | 445 | 7/14/2022 |
1.3.0 | 1,254 | 3/24/2022 |
1.2.2 | 473 | 3/2/2022 |
1.2.1 | 473 | 5/31/2021 |
1.2.0 | 406 | 5/31/2021 |
1.1.0 | 883 | 11/11/2020 |
1.0.0 | 427 | 11/5/2020 |