Relative request path: | api/orgs/{organisationId}/issuedinvoices/{issuedInvoiceId} |
Property | Description |
---|---|
organisationId | organisation id |
issuedInvoiceId | issuedInvoice id |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
IssuedInvoiceId | Issued invoice id. Mandatory. |
Year | Invoice year. Optional. Readonly. |
InvoiceNumber | Invoice number. Optional. Readonly. |
DocumentNumbering | class DocumentNumbering. Document numbering. Optional. |
Customer | class Customer. Customer. Mandatory. |
DateIssued | Invoice date. Mandatory. |
DateTransaction | Date of transaction. Optional. |
DateTransactionFrom | Start date of transaction. Optional. |
DateDue | Invoice due date. Mandatory. |
AddresseeName | Addressee name. Default value. Max length: 250. |
AddresseeAddress | Addressee address. Default value. Max length: 250. |
AddresseePostalCode | Addressee postal code. Default value. Max length: 30. |
AddresseeCity | Addressee city. Default value. Max length: 250. |
AddresseeCountryName | Addressee country name. Prohibited use when AddresseeCountry is set as home country. Default value. Max length: 250. |
AddresseeCountry | class Country. Addressee country. Default value. |
AddresseeGLN | Default value. |
RecipientName | Recipient name. Optional. Max length: 250. |
RecipientAddress | Recipient address. Optional. Max length: 250. |
RecipientPostalCode | Recipient postal code. Optional. Max length: 30. |
RecipientCity | Recipient city. Optional. Max length: 250. |
RecipientCountryName | Recipient country name. Prohibited use when RecipientCountry is set as home country. Optional. Max length: 250. |
RecipientCountry | class Country. Recipient country. Mandatory. |
RecipientGLN | Default value. |
Rabate | Rabate percent. Optional. |
ExchangeRate | Exchange rate. Optional. |
DocumentReference | Document reference. Optional. |
PaymentReference | Payment reference. Optional. Readonly. |
Currency | class Currency. Currency. Mandatory. |
Analytic | class Analytic. Analytic. Optional. |
Document | class Document. Document. Optional. Readonly. |
IssuedInvoiceReportTemplate | class ReportTemplate. Report settings for issued invoices:
|
DeliveryNoteReportTemplate | class ReportTemplate. Report settings for delivery note:
|
Status | Issued invoice and proforma invoice status:
|
DescriptionAbove | The description that appears on issued invoice and proforma invoice above. Optional. Max length: 8000. |
DescriptionBelow | The description that appears on issued invoice and proforma invoice below. Optional. Max length: 8000. |
DeliveryNoteDescriptionAbove | The description that appears on delivery note above. Optional. Max length: 8000. |
DeliveryNoteDescriptionBelow | The description that appears on delivery note below. Optional. Max length: 8000. |
Notes | Notes. Optional. Max length: 1000. |
Employee | class Employee. Employee. Optional. |
PricesOnInvoice | Price calculation type(VAT):
|
RecurringInvoice | Recurring Invoice:
|
InvoiceAttachment | class DocumentAttachment. Invoice attachment (PDF invoice document). Optional. |
EInvoiceAttachment | class DocumentAttachment. e-invoice XML file. Optional. |
InvoiceType | Input type:
|
OriginalDocumentType | Source document type for e-invoice:
|
OriginalDocumentDate | Source document date for e-invoice. Optional. |
PurposeCode | class PurposeCode. Purpose code for e-invoice and invoice with order for payment. Optional. |
PaymentStatus | Payment status:
|
InvoiceValue | Invoice value (domestic currency). Optional. Readonly. |
PaidValue | Paid value (domestic currency). Optional. Readonly. |
AssociationWithStock | Association With Issue From Stock:
|
IssuedInvoiceRows | Invoice rows. List of IssuedInvoiceRow. |
IssuedInvoicePaymentMethods | Payment methods. List of IssuedInvoicePaymentMethod. |
RecordDtModified | Optional. |
RowVersion | Row version is used for concurrency check. |
This method returns result of type 'SAOP.API.Models.IssuedInvoice.IssuedInvoice'.
/// Issued invoice details.
public class IssuedInvoice
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public long IssuedInvoiceId { get; set; }
// Invoice year.
public int? Year { get; set; }
// Invoice number.
public long? InvoiceNumber { get; set; }
// Document numbering.
public mMApiFkField DocumentNumbering { get; set; }
// Customer.
public mMApiFkField Customer { get; set; }
// Invoice date.
// Mandatory field.
public DateTime? DateIssued { get; set; }
// Date of transaction.
public DateTime? DateTransaction { get; set; }
// Start date of transaction.
public DateTime? DateTransactionFrom { get; set; }
// Invoice due date.
// Mandatory field.
public DateTime? DateDue { get; set; }
// Addressee name.
// Max length: 250
public string AddresseeName { get; set; }
// Addressee address.
// Max length: 250
public string AddresseeAddress { get; set; }
// Addressee postal code.
// Max length: 30
public string AddresseePostalCode { get; set; }
// Addressee city.
// Max length: 250
public string AddresseeCity { get; set; }
// Addressee country name. Prohibited use when AddresseeCountry is set as home country.
// Max length: 250
public string AddresseeCountryName { get; set; }
// Addressee country.
public mMApiFkField AddresseeCountry { get; set; }
public long? AddresseeGLN { get; set; }
// Recipient name.
// Max length: 250
public string RecipientName { get; set; }
// Recipient address.
// Max length: 250
public string RecipientAddress { get; set; }
// Recipient postal code.
// Max length: 30
public string RecipientPostalCode { get; set; }
// Recipient city.
// Max length: 250
public string RecipientCity { get; set; }
// Recipient country name. Prohibited use when RecipientCountry is set as home country.
// Max length: 250
public string RecipientCountryName { get; set; }
// Recipient country.
public mMApiFkField RecipientCountry { get; set; }
public long? RecipientGLN { get; set; }
// Rabate percent.
public Decimal Rabate { get; set; }
// Exchange rate.
public Decimal ExchangeRate { get; set; }
// Document reference.
public string DocumentReference { get; set; }
// Payment reference.
public string PaymentReference { get; set; }
// Currency.
public mMApiFkField Currency { get; set; }
// Analytic.
public mMApiFkField Analytic { get; set; }
// Document.
public mMApiFkField Document { get; set; }
// Report settings for issued invoices:
// <ul>
//     <li>IR – for issued invoice,</li>
//     <li>DP – for credit note,</li>
//     <li>UP – for issued invoice with order for payment.</li>
// </ul>
// Report settings for proforma invoices:
// <ul>
//     <li>PR – for proforma invoice,</li>
//     <li>PUPN – for proforma invoice with order for payment.</li>
// </ul>
public mMApiFkField IssuedInvoiceReportTemplate { get; set; }
// Report settings for delivery note:
// <ul>
//     <li>DO – for delivery note </li>
// </ul>
public mMApiFkField DeliveryNoteReportTemplate { get; set; }
// Issued invoice and proforma invoice status:
// <ul>
//     <li>O – Draft,</li>
//     <li>I - Issued</li>
// </ul>
// Mandatory field. Max length: 1
public string Status { get; set; }
// The description that appears on issued invoice and proforma invoice above.
// Max length: 8000
public string DescriptionAbove { get; set; }
// The description that appears on issued invoice and proforma invoice below.
// Max length: 8000
public string DescriptionBelow { get; set; }
// The description that appears on delivery note above.
// Max length: 8000
public string DeliveryNoteDescriptionAbove { get; set; }
// The description that appears on delivery note below.
// Max length: 8000
public string DeliveryNoteDescriptionBelow { get; set; }
// Notes.
// Max length: 1000
public string Notes { get; set; }
// Employee.
public mMApiFkField Employee { get; set; }
// Price calculation type(VAT):
// <ul>
//     <li>D - VAT is included in the price</li>
//     <li>N - VAT is added to the prices</li>
// </ul>
// Max length: 1
public string PricesOnInvoice { get; set; }
// Recurring Invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public string RecurringInvoice { get; set; }
// Invoice attachment (PDF invoice document).
public mMApiFkField InvoiceAttachment { get; set; }
// e-invoice XML file.
public mMApiFkField EInvoiceAttachment { get; set; }
// Input type:
// <ul>
//     <li>R – issued invoice,</li>
//     <li>P – proforma invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public string InvoiceType { get; set; }
// Source document type for e-invoice:
// <ul>
//     <li>IV - invoice</li>
//     <li>AAB – proforma invoice</li>
//     <li>AAK – delivery note</li>
//     <li>CD – credit note</li>
//     <li>CT - contract</li>
//     <li>ON - purchase order</li>
//     <li>VN - sales order</li>
//     <li>AEP - project</li>
//     <li>ALO - recipient</li>
//     <li>GC - public tender</li>
//     <li>ATS - object</li>
// </ul>
// Max length: 30
public string OriginalDocumentType { get; set; }
// Source document date for e-invoice.
public DateTime? OriginalDocumentDate { get; set; }
// Purpose code for e-invoice and invoice with order for payment.
public mMApiFkField PurposeCode { get; set; }
// Payment status:
// <ul>
//     <li>Placan – Paid</li>
//     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
//     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
//     <li>NeplacanZapadel – Unpaid, Overdue</li>
//     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
//     <li>Osnutek – Draft</li>
//     <li>Avans – Advance payment</li>
// </ul>
// Max length: 20
public string PaymentStatus { get; set; }
// Invoice value (domestic currency).
public Decimal InvoiceValue { get; set; }
// Paid value (domestic currency).
public Decimal PaidValue { get; set; }
// Association With Issue From Stock:
// <ul>
//     <li>N – no</li>
//     <li>D – yes</li>
// </ul>
// Max length: 1
public string AssociationWithStock { get; set; }
// Invoice rows.
public List<IssuedInvoiceRow> IssuedInvoiceRows { get; set; }
// Payment methods.
public List<IssuedInvoicePaymentMethod> IssuedInvoicePaymentMethods { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
/// Issued invoice row details.
public class IssuedInvoiceRow
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public long IssuedInvoiceRowId { get; set; }
// Issued invoice.
public mMApiFkField IssuedInvoice { get; set; }
// Item.
public mMApiFkField Item { get; set; }
// Item name.
// Max length: 250
public string ItemName { get; set; }
// Issued invoice row number.
// Mandatory field.
public int? RowNumber { get; set; }
// Item code.
// Max length: 30
public string ItemCode { get; set; }
// Serial number.
// Max length: 30
public string SerialNumber { get; set; }
// Batch number.
// Max length: 30
public string BatchNumber { get; set; }
// Item description.
// Max length: 8000
public string Description { get; set; }
// Item quantity.
// Mandatory field.
public Decimal Quantity { get; set; }
// Item unit of measurement.
// Max length: 3
public string UnitOfMeasurement { get; set; }
// Mass of item in kilogram.
public Decimal Mass { get; set; }
// Price.
// Mandatory field.
public Decimal Price { get; set; }
// Price with included VAT.
// Mandatory field.
public Decimal PriceWithVAT { get; set; }
// Item VAT percent.
// Mandatory field.
public Decimal VATPercent { get; set; }
// Discount value in currency.
// Mandatory field.
public Decimal Discount { get; set; }
// Discount value in percent.
// Mandatory field.
public Decimal DiscountPercent { get; set; }
// Row value.
// Mandatory field.
public Decimal Value { get; set; }
// Item VAT rate.
public mMApiFkField VatRate { get; set; }
// Vat rate percentage identifier
public mMApiFkField VatRatePercentage { get; set; }
// Warehouse. Input allowed if settings are set for direct discharge(Inventory).
public mMApiFkField Warehouse { get; set; }
// Warehouse. Input allowed if settings are set for discharge from additional warehouse.
public mMApiFkField AdditionalWarehouse { get; set; }
// Tax-free value.
public Decimal TaxFreeValue { get; set; }
// Tax-exemption value.
public Decimal TaxExemptionValue { get; set; }
// VAT accounting type.
// Max length: 5
public string VatAccountingType { get; set; }
// Code for tax exemption reason. Only for e-invoice for Minimax RS.
public string TaxExemptionReasonCode { get; set; }
// Analytic.
public mMApiFkField Analytic { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
/// Issued invoice payment method details.
public class IssuedInvoicePaymentMethod
{
// Issued invoice payment method id.
// Mandatory field. Ignored on create request.
public long IssuedInvoicePaymentMethodId { get; set; }
// Issued invoice.
public mMApiFkField IssuedInvoice { get; set; }
// Payment method.
public mMApiFkField PaymentMethod { get; set; }
// Cash register, if payment goes through a cash register.
public mMApiFkField CashRegister { get; set; }
// Revenue, if payment goes through a cash register.
public mMApiFkField Revenue { get; set; }
// Revenue date, if payment goes through a cash register.
public DateTime? RevenueDate { get; set; }
// Payment amount in invoice currency.
public Decimal Amount { get; set; }
// Payment amount in domestic currency.
public Decimal AmountInDomesticCurrency { get; set; }
// Already paid flag:
// <ul>
//     <li>D – amount was already paid at the time of issuing the invoice,</li>
//     <li>N – amount was not already paid at the time of issuing the invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public string AlreadyPaid { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
This method returns result of type 'SAOP.API.Models.IssuedInvoice.IssuedInvoice'.
/// Issued invoice details.
class IssuedInvoice
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public $IssuedInvoiceId;
// Invoice year.
public $Year;
// Invoice number.
public $InvoiceNumber;
// Document numbering.
public $DocumentNumbering;
// Customer.
public $Customer;
// Invoice date.
// Mandatory field.
public $DateIssued;
// Date of transaction.
public $DateTransaction;
// Start date of transaction.
public $DateTransactionFrom;
// Invoice due date.
// Mandatory field.
public $DateDue;
// Addressee name.
// Max length: 250
public $AddresseeName;
// Addressee address.
// Max length: 250
public $AddresseeAddress;
// Addressee postal code.
// Max length: 30
public $AddresseePostalCode;
// Addressee city.
// Max length: 250
public $AddresseeCity;
// Addressee country name. Prohibited use when AddresseeCountry is set as home country.
// Max length: 250
public $AddresseeCountryName;
// Addressee country.
public $AddresseeCountry;
public $AddresseeGLN;
// Recipient name.
// Max length: 250
public $RecipientName;
// Recipient address.
// Max length: 250
public $RecipientAddress;
// Recipient postal code.
// Max length: 30
public $RecipientPostalCode;
// Recipient city.
// Max length: 250
public $RecipientCity;
// Recipient country name. Prohibited use when RecipientCountry is set as home country.
// Max length: 250
public $RecipientCountryName;
// Recipient country.
public $RecipientCountry;
public $RecipientGLN;
// Rabate percent.
public $Rabate;
// Exchange rate.
public $ExchangeRate;
// Document reference.
public $DocumentReference;
// Payment reference.
public $PaymentReference;
// Currency.
public $Currency;
// Analytic.
public $Analytic;
// Document.
public $Document;
// Report settings for issued invoices:
// <ul>
//     <li>IR – for issued invoice,</li>
//     <li>DP – for credit note,</li>
//     <li>UP – for issued invoice with order for payment.</li>
// </ul>
// Report settings for proforma invoices:
// <ul>
//     <li>PR – for proforma invoice,</li>
//     <li>PUPN – for proforma invoice with order for payment.</li>
// </ul>
public $IssuedInvoiceReportTemplate;
// Report settings for delivery note:
// <ul>
//     <li>DO – for delivery note </li>
// </ul>
public $DeliveryNoteReportTemplate;
// Issued invoice and proforma invoice status:
// <ul>
//     <li>O – Draft,</li>
//     <li>I - Issued</li>
// </ul>
// Mandatory field. Max length: 1
public $Status;
// The description that appears on issued invoice and proforma invoice above.
// Max length: 8000
public $DescriptionAbove;
// The description that appears on issued invoice and proforma invoice below.
// Max length: 8000
public $DescriptionBelow;
// The description that appears on delivery note above.
// Max length: 8000
public $DeliveryNoteDescriptionAbove;
// The description that appears on delivery note below.
// Max length: 8000
public $DeliveryNoteDescriptionBelow;
// Notes.
// Max length: 1000
public $Notes;
// Employee.
public $Employee;
// Price calculation type(VAT):
// <ul>
//     <li>D - VAT is included in the price</li>
//     <li>N - VAT is added to the prices</li>
// </ul>
// Max length: 1
public $PricesOnInvoice;
// Recurring Invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public $RecurringInvoice;
// Invoice attachment (PDF invoice document).
public $InvoiceAttachment;
// e-invoice XML file.
public $EInvoiceAttachment;
// Input type:
// <ul>
//     <li>R – issued invoice,</li>
//     <li>P – proforma invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public $InvoiceType;
// Source document type for e-invoice:
// <ul>
//     <li>IV - invoice</li>
//     <li>AAB – proforma invoice</li>
//     <li>AAK – delivery note</li>
//     <li>CD – credit note</li>
//     <li>CT - contract</li>
//     <li>ON - purchase order</li>
//     <li>VN - sales order</li>
//     <li>AEP - project</li>
//     <li>ALO - recipient</li>
//     <li>GC - public tender</li>
//     <li>ATS - object</li>
// </ul>
// Max length: 30
public $OriginalDocumentType;
// Source document date for e-invoice.
public $OriginalDocumentDate;
// Purpose code for e-invoice and invoice with order for payment.
public $PurposeCode;
// Payment status:
// <ul>
//     <li>Placan – Paid</li>
//     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
//     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
//     <li>NeplacanZapadel – Unpaid, Overdue</li>
//     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
//     <li>Osnutek – Draft</li>
//     <li>Avans – Advance payment</li>
// </ul>
// Max length: 20
public $PaymentStatus;
// Invoice value (domestic currency).
public $InvoiceValue;
// Paid value (domestic currency).
public $PaidValue;
// Association With Issue From Stock:
// <ul>
//     <li>N – no</li>
//     <li>D – yes</li>
// </ul>
// Max length: 1
public $AssociationWithStock;
// Invoice rows.
public $IssuedInvoiceRows;
// Payment methods.
public $IssuedInvoicePaymentMethods;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
/// Issued invoice row details.
class IssuedInvoiceRow
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public $IssuedInvoiceRowId;
// Issued invoice.
public $IssuedInvoice;
// Item.
public $Item;
// Item name.
// Max length: 250
public $ItemName;
// Issued invoice row number.
// Mandatory field.
public $RowNumber;
// Item code.
// Max length: 30
public $ItemCode;
// Serial number.
// Max length: 30
public $SerialNumber;
// Batch number.
// Max length: 30
public $BatchNumber;
// Item description.
// Max length: 8000
public $Description;
// Item quantity.
// Mandatory field.
public $Quantity;
// Item unit of measurement.
// Max length: 3
public $UnitOfMeasurement;
// Mass of item in kilogram.
public $Mass;
// Price.
// Mandatory field.
public $Price;
// Price with included VAT.
// Mandatory field.
public $PriceWithVAT;
// Item VAT percent.
// Mandatory field.
public $VATPercent;
// Discount value in currency.
// Mandatory field.
public $Discount;
// Discount value in percent.
// Mandatory field.
public $DiscountPercent;
// Row value.
// Mandatory field.
public $Value;
// Item VAT rate.
public $VatRate;
// Vat rate percentage identifier
public $VatRatePercentage;
// Warehouse. Input allowed if settings are set for direct discharge(Inventory).
public $Warehouse;
// Warehouse. Input allowed if settings are set for discharge from additional warehouse.
public $AdditionalWarehouse;
// Tax-free value.
public $TaxFreeValue;
// Tax-exemption value.
public $TaxExemptionValue;
// VAT accounting type.
// Max length: 5
public $VatAccountingType;
// Code for tax exemption reason. Only for e-invoice for Minimax RS.
public $TaxExemptionReasonCode;
// Analytic.
public $Analytic;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
/// Issued invoice payment method details.
class IssuedInvoicePaymentMethod
{
// Issued invoice payment method id.
// Mandatory field. Ignored on create request.
public $IssuedInvoicePaymentMethodId;
// Issued invoice.
public $IssuedInvoice;
// Payment method.
public $PaymentMethod;
// Cash register, if payment goes through a cash register.
public $CashRegister;
// Revenue, if payment goes through a cash register.
public $Revenue;
// Revenue date, if payment goes through a cash register.
public $RevenueDate;
// Payment amount in invoice currency.
public $Amount;
// Payment amount in domestic currency.
public $AmountInDomesticCurrency;
// Already paid flag:
// <ul>
//     <li>D – amount was already paid at the time of issuing the invoice,</li>
//     <li>N – amount was not already paid at the time of issuing the invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public $AlreadyPaid;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
This method returns result of type 'SAOP.API.Models.IssuedInvoice.IssuedInvoice'.
/// Issued invoice details.
public class IssuedInvoice
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public Long IssuedInvoiceId;
// Invoice year.
public Integer Year;
// Invoice number.
public Long InvoiceNumber;
// Document numbering.
public mMApiFkField DocumentNumbering;
// Customer.
public mMApiFkField Customer;
// Invoice date.
// Mandatory field.
public Date DateIssued;
// Date of transaction.
public Date DateTransaction;
// Start date of transaction.
public Date DateTransactionFrom;
// Invoice due date.
// Mandatory field.
public Date DateDue;
// Addressee name.
// Max length: 250
public String AddresseeName;
// Addressee address.
// Max length: 250
public String AddresseeAddress;
// Addressee postal code.
// Max length: 30
public String AddresseePostalCode;
// Addressee city.
// Max length: 250
public String AddresseeCity;
// Addressee country name. Prohibited use when AddresseeCountry is set as home country.
// Max length: 250
public String AddresseeCountryName;
// Addressee country.
public mMApiFkField AddresseeCountry;
public Long AddresseeGLN;
// Recipient name.
// Max length: 250
public String RecipientName;
// Recipient address.
// Max length: 250
public String RecipientAddress;
// Recipient postal code.
// Max length: 30
public String RecipientPostalCode;
// Recipient city.
// Max length: 250
public String RecipientCity;
// Recipient country name. Prohibited use when RecipientCountry is set as home country.
// Max length: 250
public String RecipientCountryName;
// Recipient country.
public mMApiFkField RecipientCountry;
public Long RecipientGLN;
// Rabate percent.
public Double Rabate;
// Exchange rate.
public Double ExchangeRate;
// Document reference.
public String DocumentReference;
// Payment reference.
public String PaymentReference;
// Currency.
public mMApiFkField Currency;
// Analytic.
public mMApiFkField Analytic;
// Document.
public mMApiFkField Document;
// Report settings for issued invoices:
// <ul>
//     <li>IR – for issued invoice,</li>
//     <li>DP – for credit note,</li>
//     <li>UP – for issued invoice with order for payment.</li>
// </ul>
// Report settings for proforma invoices:
// <ul>
//     <li>PR – for proforma invoice,</li>
//     <li>PUPN – for proforma invoice with order for payment.</li>
// </ul>
public mMApiFkField IssuedInvoiceReportTemplate;
// Report settings for delivery note:
// <ul>
//     <li>DO – for delivery note </li>
// </ul>
public mMApiFkField DeliveryNoteReportTemplate;
// Issued invoice and proforma invoice status:
// <ul>
//     <li>O – Draft,</li>
//     <li>I - Issued</li>
// </ul>
// Mandatory field. Max length: 1
public String Status;
// The description that appears on issued invoice and proforma invoice above.
// Max length: 8000
public String DescriptionAbove;
// The description that appears on issued invoice and proforma invoice below.
// Max length: 8000
public String DescriptionBelow;
// The description that appears on delivery note above.
// Max length: 8000
public String DeliveryNoteDescriptionAbove;
// The description that appears on delivery note below.
// Max length: 8000
public String DeliveryNoteDescriptionBelow;
// Notes.
// Max length: 1000
public String Notes;
// Employee.
public mMApiFkField Employee;
// Price calculation type(VAT):
// <ul>
//     <li>D - VAT is included in the price</li>
//     <li>N - VAT is added to the prices</li>
// </ul>
// Max length: 1
public String PricesOnInvoice;
// Recurring Invoice:
// <ul>
//     <li>D – yes,</li>
//     <li>N – no.</li>
// </ul>
// Max length: 1
public String RecurringInvoice;
// Invoice attachment (PDF invoice document).
public mMApiFkField InvoiceAttachment;
// e-invoice XML file.
public mMApiFkField EInvoiceAttachment;
// Input type:
// <ul>
//     <li>R – issued invoice,</li>
//     <li>P – proforma invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public String InvoiceType;
// Source document type for e-invoice:
// <ul>
//     <li>IV - invoice</li>
//     <li>AAB – proforma invoice</li>
//     <li>AAK – delivery note</li>
//     <li>CD – credit note</li>
//     <li>CT - contract</li>
//     <li>ON - purchase order</li>
//     <li>VN - sales order</li>
//     <li>AEP - project</li>
//     <li>ALO - recipient</li>
//     <li>GC - public tender</li>
//     <li>ATS - object</li>
// </ul>
// Max length: 30
public String OriginalDocumentType;
// Source document date for e-invoice.
public Date OriginalDocumentDate;
// Purpose code for e-invoice and invoice with order for payment.
public mMApiFkField PurposeCode;
// Payment status:
// <ul>
//     <li>Placan – Paid</li>
//     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
//     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
//     <li>NeplacanZapadel – Unpaid, Overdue</li>
//     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
//     <li>Osnutek – Draft</li>
//     <li>Avans – Advance payment</li>
// </ul>
// Max length: 20
public String PaymentStatus;
// Invoice value (domestic currency).
public Double InvoiceValue;
// Paid value (domestic currency).
public Double PaidValue;
// Association With Issue From Stock:
// <ul>
//     <li>N – no</li>
//     <li>D – yes</li>
// </ul>
// Max length: 1
public String AssociationWithStock;
// Invoice rows.
public List<IssuedInvoiceRow> IssuedInvoiceRows;
// Payment methods.
public List<IssuedInvoicePaymentMethod> IssuedInvoicePaymentMethods;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}
/// Issued invoice row details.
public class IssuedInvoiceRow
{
// Issued invoice id.
// Mandatory field. Ignored on create request.
public Long IssuedInvoiceRowId;
// Issued invoice.
public mMApiFkField IssuedInvoice;
// Item.
public mMApiFkField Item;
// Item name.
// Max length: 250
public String ItemName;
// Issued invoice row number.
// Mandatory field.
public Integer RowNumber;
// Item code.
// Max length: 30
public String ItemCode;
// Serial number.
// Max length: 30
public String SerialNumber;
// Batch number.
// Max length: 30
public String BatchNumber;
// Item description.
// Max length: 8000
public String Description;
// Item quantity.
// Mandatory field.
public Double Quantity;
// Item unit of measurement.
// Max length: 3
public String UnitOfMeasurement;
// Mass of item in kilogram.
public Double Mass;
// Price.
// Mandatory field.
public Double Price;
// Price with included VAT.
// Mandatory field.
public Double PriceWithVAT;
// Item VAT percent.
// Mandatory field.
public Double VATPercent;
// Discount value in currency.
// Mandatory field.
public Double Discount;
// Discount value in percent.
// Mandatory field.
public Double DiscountPercent;
// Row value.
// Mandatory field.
public Double Value;
// Item VAT rate.
public mMApiFkField VatRate;
// Vat rate percentage identifier
public mMApiFkField VatRatePercentage;
// Warehouse. Input allowed if settings are set for direct discharge(Inventory).
public mMApiFkField Warehouse;
// Warehouse. Input allowed if settings are set for discharge from additional warehouse.
public mMApiFkField AdditionalWarehouse;
// Tax-free value.
public Double TaxFreeValue;
// Tax-exemption value.
public Double TaxExemptionValue;
// VAT accounting type.
// Max length: 5
public String VatAccountingType;
// Code for tax exemption reason. Only for e-invoice for Minimax RS.
public String TaxExemptionReasonCode;
// Analytic.
public mMApiFkField Analytic;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}
/// Issued invoice payment method details.
public class IssuedInvoicePaymentMethod
{
// Issued invoice payment method id.
// Mandatory field. Ignored on create request.
public Long IssuedInvoicePaymentMethodId;
// Issued invoice.
public mMApiFkField IssuedInvoice;
// Payment method.
public mMApiFkField PaymentMethod;
// Cash register, if payment goes through a cash register.
public mMApiFkField CashRegister;
// Revenue, if payment goes through a cash register.
public mMApiFkField Revenue;
// Revenue date, if payment goes through a cash register.
public Date RevenueDate;
// Payment amount in invoice currency.
public Double Amount;
// Payment amount in domestic currency.
public Double AmountInDomesticCurrency;
// Already paid flag:
// <ul>
//     <li>D – amount was already paid at the time of issuing the invoice,</li>
//     <li>N – amount was not already paid at the time of issuing the invoice.</li>
// </ul>
// Mandatory field. Max length: 1
public String AlreadyPaid;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}