Skip to content

Latest commit

 

History

History
1815 lines (1180 loc) · 63.5 KB

File metadata and controls

1815 lines (1180 loc) · 63.5 KB

Altairis.Fakturoid.Client.dll v.2.9.0.0 API documentation

All types

ExpensePaymentStatus Enum FakturoidTodosProxy Class JsonEvent Class
ExpenseStatusCondition Enum InternalExtensionMethods Class JsonExpense Class
FakturoidBankAccountsProxy Class InvoiceMessageType Enum JsonExpenseLine Class
FakturoidContext Class InvoicePaymentStatus Enum JsonInvoice Class
FakturoidEntityProxy Class InvoiceStatusCondition Enum JsonInvoiceLine Class
FakturoidEventsProxy Class InvoiceTypeCondition Enum JsonSubject Class
FakturoidException Class JsonAccount Class JsonTodo Class
FakturoidExpensesProxy Class JsonAttachment Class AllowNullAttribute Class
FakturoidInvoicesProxy Class JsonBankAccount Class NotNullWhenAttribute Class
FakturoidSubjectsProxy Class JsonEntityLine Class

ExpensePaymentStatus Enum

Namespace: Altairis.Fakturoid.Client

Expense payment status

Values

Name Summary
Unpaid Reset payment status to unpaid.
Paid Set status of regular expense to paid.

ExpenseStatusCondition Enum

Namespace: Altairis.Fakturoid.Client

Query status condition for listing expenses

Values

Name Summary
Any Any
Open Náklad není zaplacen, odeslán ani po splatnosti.
Overdue Náklad je po splatnosti.
Paid Náklad je zaplacen.

FakturoidBankAccountsProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class form working with bank accounts

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
Select() IEnumerable<JsonBankAccount> Gets list of all bank accounts.
SelectAsync() Task<IEnumerable<JsonBankAccount>> Gets asynchronously list of all bank accounts.

Methods

Select()

Gets list of all bank accounts.

Returns

IEnumerable<JsonBankAccount>

List of Altairis.Fakturoid.Client.JsonBankAccount instances.

SelectAsync()

Gets asynchronously list of all bank accounts.

Returns

Task<IEnumerable<JsonBankAccount>>

List of Altairis.Fakturoid.Client.JsonBankAccount instances.

FakturoidContext Class

Namespace: Altairis.Fakturoid.Client

Class representing connection to Fakturoid API, holds authentication information etc.

Properties

Name Type Summary
AccountName string Gets the Fakturoid account name.
EmailAddress string Gets the Fakturoid account email address.
AuthenticationToken string Gets the Fakturoid authentication token.
UserAgent string Gets the User-Agent header used for HTTP requests.
Events FakturoidEventsProxy Proxy for working with events.
Todos FakturoidTodosProxy Proxy for working with todos.
Subjects FakturoidSubjectsProxy Proxy for working with subjects.
Invoices FakturoidInvoicesProxy Proxy for working with invoices
Expenses FakturoidExpensesProxy Proxy for working with expenses
BankAccounts FakturoidBankAccountsProxy Proxy for working with bank accounts.

Constructors

Name Summary
FakturoidContext(string accountName, string emailAddress, string authenticationToken, string userAgent) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidContext class.

Methods

Name Returns Summary
GetAccountInfo() JsonAccount Gets the account information.

Constructors

FakturoidContext(string accountName, string emailAddress, string authenticationToken, string userAgent)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidContext class.

Parameter Type Description
accountName string Account name (accountName).
emailAddress string The email address od user being authenticated.
authenticationToken string The authentication token.
userAgent string The User-Agent HTTP header value.

Methods

GetAccountInfo()

Gets the account information.

Returns

JsonAccount

Instance of Altairis.Fakturoid.Client.JsonAccount class containing the account information.

FakturoidEntityProxy Class

Namespace: Altairis.Fakturoid.Client

Proxy class for working with any Fakturoid entity

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

FakturoidEventsProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class for working with events

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
Select(DateTime? since) IEnumerable<JsonEvent> Gets list of all current events.
Select(int page, DateTime? since) IEnumerable<JsonEvent> Gets list of current events, paged by 15.
SelectAsync(DateTime? since) Task<IEnumerable<JsonEvent>> Gets asynchronously list of all current events.
SelectAsync(int page, DateTime? since) Task<IEnumerable<JsonEvent>> Gets asynchronously list of current events, paged by 15.

Methods

Select(DateTime? since)

Gets list of all current events.

Parameter Type Description
since DateTime? The date since when events are to be selected.

Returns

IEnumerable<JsonEvent>

List of Altairis.Fakturoid.Client.JsonEvent instances.

Select(int page, DateTime? since)

Gets list of current events, paged by 15.

Parameter Type Description
page int The page number.
since DateTime? The date since when events are to be selected.

Returns

IEnumerable<JsonEvent>

List of Altairis.Fakturoid.Client.JsonEvent instances.

SelectAsync(DateTime? since)

Gets asynchronously list of all current events.

Parameter Type Description
since DateTime? The date since when events are to be selected.

Returns

Task<IEnumerable<JsonEvent>>

List of Altairis.Fakturoid.Client.JsonEvent instances.

SelectAsync(int page, DateTime? since)

Gets asynchronously list of current events, paged by 15.

Parameter Type Description
page int The page number.
since DateTime? The date since when events are to be selected.

Returns

Task<IEnumerable<JsonEvent>>

List of Altairis.Fakturoid.Client.JsonEvent instances.

FakturoidException Class

Namespace: Altairis.Fakturoid.Client

Base class: Exception

The exception representing error returned by Fakturoid API.

Properties

Name Type Summary
Response HttpResponseMessage Gets or sets the related HTTP response object.
ResponseBody string Gets the HTTP response body as string.
Errors IEnumerable<KeyValuePair<string, string>> Gets the errors returned by Fakturoid API.
TargetSite MethodBase
StackTrace string
Message string
Data IDictionary
InnerException Exception
HelpLink string
Source string
HResult int

Constructors

Name Summary
FakturoidException() Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.
FakturoidException(string message) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.
FakturoidException(HttpResponseMessage response) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.
FakturoidException(string format, Object[] args) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.
FakturoidException(string message, Exception innerException) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.
FakturoidException(string format, Exception innerException, Object[] args) Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Methods

Name Returns Summary
GetObjectData(SerializationInfo info, StreamingContext context) void Sets the System.Runtime.Serialization.SerializationInfo with information about the exception.

Constructors

FakturoidException()

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

FakturoidException(string message)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Parameter Type Description
message string The message that describes the error.

FakturoidException(HttpResponseMessage response)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Parameter Type Description
response HttpResponseMessage The HTTP response to get exception information from.

FakturoidException(string format, Object[] args)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Parameter Type Description
format string The format.
args Object[] The args.

FakturoidException(string message, Exception innerException)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Parameter Type Description
message string The error message that explains the reason for the exception.
innerException Exception The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

FakturoidException(string format, Exception innerException, Object[] args)

Initializes a new instance of the Altairis.Fakturoid.Client.FakturoidException class.

Parameter Type Description
format string The format.
innerException Exception The inner exception.
args Object[] The args.

Methods

GetObjectData(SerializationInfo info, StreamingContext context)

Sets the System.Runtime.Serialization.SerializationInfo with information about the exception.

Parameter Type Description
info SerializationInfo The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context StreamingContext The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

FakturoidExpensesProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class for working with invoices.

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
[Create(JsonExpense entity)](#createjsonexpensejsonexpense-class-entity) int Creates the specified new expense.
[CreateAsync(JsonExpense entity)](#createasyncjsonexpensejsonexpense-class-entity) Task<int> Creates asynchronously the specified new expense.
Delete(int id) void Deletes expense with specified id.
DeleteAsync(int id) Task Deletes asynchronously expense with specified id.
[Select(ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)](#selectexpensestatusconditionexpensestatuscondition-enum-status-int-subjectid-datetime-since-string-number) IEnumerable<JsonExpense> Gets list of all invoices.
[Select(int page, ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)](#selectint-page-expensestatusconditionexpensestatuscondition-enum-status-int-subjectid-datetime-since-string-number) IEnumerable<JsonExpense> Gets paged list of invoices.
[SelectAsync(ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)](#selectasyncexpensestatusconditionexpensestatuscondition-enum-status-int-subjectid-datetime-since-string-number) Task<IEnumerable<JsonExpense>> Gets asynchronously list of all invoices.
[SelectAsync(int page, ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)](#selectasyncint-page-expensestatusconditionexpensestatuscondition-enum-status-int-subjectid-datetime-since-string-number) Task<IEnumerable<JsonExpense>> Gets asynchronously paged list of invoices.
SelectSingle(int id) JsonExpense Selects single expense with specified ID.
SelectSingleAsync(int id) Task<JsonExpense> Selects asynchronously single expense with specified ID.
SetAttachment(int id, string filePath) void Sets attachment for invoice.
SetAttachment(int id, string mimeType, byte[] fileContent) void Sets attachment for invoice.
SetAttachmentAsync(int id, string filePath) Task Sets attachment for invoice.
SetAttachmentAsync(int id, string mimeType, byte[] fileContent) Task Sets attachment for invoice.
[SetPaymentStatus(int id, ExpensePaymentStatus status)](#setpaymentstatusint-id-expensepaymentstatusexpensepaymentstatus-enum-status) void Sets the expense payment status.
[SetPaymentStatus(int id, ExpensePaymentStatus status, DateTime effectiveDate)](#setpaymentstatusint-id-expensepaymentstatusexpensepaymentstatus-enum-status-datetime-effectivedate) void Sets the expense payment status.
[SetPaymentStatusAsync(int id, ExpensePaymentStatus status)](#setpaymentstatusasyncint-id-expensepaymentstatusexpensepaymentstatus-enum-status) Task Sets asynchronously the expense payment status.
[SetPaymentStatusAsync(int id, ExpensePaymentStatus status, DateTime effectiveDate)](#setpaymentstatusasyncint-id-expensepaymentstatusexpensepaymentstatus-enum-status-datetime-effectivedate) Task Sets asynchronously the expense payment status.
[Update(JsonExpense entity)](#updatejsonexpensejsonexpense-class-entity) JsonExpense Updates the specified expense.
[UpdateAsync(JsonExpense entity)](#updateasyncjsonexpensejsonexpense-class-entity) Task<JsonExpense> Updates asynchronously the specified expense.

Methods

Create(JsonExpense entity)

Creates the specified new expense.

Parameter Type Description
entity JsonExpense The new expense.

Returns

int

ID of newly created expense.

CreateAsync(JsonExpense entity)

Creates asynchronously the specified new expense.

Parameter Type Description
entity JsonExpense The new expense.

Returns

Task

ID of newly created expense.

Delete(int id)

Deletes expense with specified id.

Parameter Type Description
id int The contact id.

DeleteAsync(int id)

Deletes asynchronously expense with specified id.

Parameter Type Description
id int The contact id.

Returns

Task

Select(ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)

Gets list of all invoices.

Parameter Type Description
status ExpenseStatusCondition The expense status.
subjectId int? The customer subject id.
since DateTime? The date since when the expense was created.
number string The expense display number.

Returns

IEnumerable<JsonExpense>

List of Altairis.Fakturoid.Client.JsonExpense instances.

Select(int page, ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)

Gets paged list of invoices.

Parameter Type Description
page int The page number.
status ExpenseStatusCondition The expense status.
subjectId int? The customer subject id.
since DateTime? The date since when the expense was created.
number string The expense display number.

Returns

IEnumerable<JsonExpense>

List of Altairis.Fakturoid.Client.JsonExpense instances.

SelectAsync(ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)

Gets asynchronously list of all invoices.

Parameter Type Description
status ExpenseStatusCondition The expense status.
subjectId int? The customer subject id.
since DateTime? The date since when the expense was created.
number string The expense display number.

Returns

Task<IEnumerable<JsonExpense>>

List of Altairis.Fakturoid.Client.JsonExpense instances.

SelectAsync(int page, ExpenseStatusCondition status, int? subjectId, DateTime? since, string number)

Gets asynchronously paged list of invoices.

Parameter Type Description
page int The page number.
status ExpenseStatusCondition The expense status.
subjectId int? The customer subject id.
since DateTime? The date since when the expense was created.
number string The expense display number.

Returns

Task<IEnumerable<JsonExpense>>

List of Altairis.Fakturoid.Client.JsonExpense instances.

SelectSingle(int id)

Selects single expense with specified ID.

Parameter Type Description
id int The expense id.

Returns

JsonExpense

Instance of Altairis.Fakturoid.Client.JsonExpense class.

SelectSingleAsync(int id)

Selects asynchronously single expense with specified ID.

Parameter Type Description
id int The expense id.

Returns

Task<JsonExpense>

Instance of Altairis.Fakturoid.Client.JsonExpense class.

SetAttachment(int id, string filePath)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
filePath string The file path.

SetAttachment(int id, string mimeType, byte[] fileContent)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
mimeType string The mime type.
fileContent byte[] The content of the file.

SetAttachmentAsync(int id, string filePath)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
filePath string The file path.

Returns

Task

SetAttachmentAsync(int id, string mimeType, byte[] fileContent)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
mimeType string The mime type.
fileContent byte[] The content of the file.

Returns

Task

SetPaymentStatus(int id, ExpensePaymentStatus status)

Sets the expense payment status.

Parameter Type Description
id int The expense id.
status ExpensePaymentStatus The new payment status.

SetPaymentStatus(int id, ExpensePaymentStatus status, DateTime effectiveDate)

Sets the expense payment status.

Parameter Type Description
id int The expense id.
status ExpensePaymentStatus The new payment status.
effectiveDate DateTime The date when payment was performed.

SetPaymentStatusAsync(int id, ExpensePaymentStatus status)

Sets asynchronously the expense payment status.

Parameter Type Description
id int The expense id.
status ExpensePaymentStatus The new payment status.

Returns

Task

Instance of Altairis.Fakturoid.Client.JsonExpense class with modified entity.

SetPaymentStatusAsync(int id, ExpensePaymentStatus status, DateTime effectiveDate)

Sets asynchronously the expense payment status.

Parameter Type Description
id int The expense id.
status ExpensePaymentStatus The new payment status.
effectiveDate DateTime The date when payment was performed.

Returns

Task

Update(JsonExpense entity)

Updates the specified expense.

Parameter Type Description
entity JsonExpense The expense to update.

Returns

JsonExpense

Instance of Altairis.Fakturoid.Client.JsonExpense class with modified entity.

UpdateAsync(JsonExpense entity)

Updates asynchronously the specified expense.

Parameter Type Description
entity JsonExpense The expense to update.

Returns

Task<JsonExpense>

Instance of Altairis.Fakturoid.Client.JsonExpense class with modified entity.

FakturoidInvoicesProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class for working with invoices.

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
[Create(JsonInvoice entity)](#createjsoninvoicejsoninvoice-class-entity) int Creates the specified new invoice.
[CreateAsync(JsonInvoice entity)](#createasyncjsoninvoicejsoninvoice-class-entity) Task<int> Creates asynchronously the specified new invoice.
Delete(int id) void Deletes invoice with specified id.
DeleteAsync(int id) Task Deletes asynchronously invoice with specified id.
[Select(InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)](#selectinvoicetypeconditioninvoicetypecondition-enum-type-invoicestatusconditioninvoicestatuscondition-enum-status-int-subjectid-datetime-since-string-number) IEnumerable<JsonInvoice> Gets list of all invoices.
[Select(int page, InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)](#selectint-page-invoicetypeconditioninvoicetypecondition-enum-type-invoicestatusconditioninvoicestatuscondition-enum-status-int-subjectid-datetime-since-string-number) IEnumerable<JsonInvoice> Gets paged list of invoices.
[SelectAsync(InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)](#selectasyncinvoicetypeconditioninvoicetypecondition-enum-type-invoicestatusconditioninvoicestatuscondition-enum-status-int-subjectid-datetime-since-string-number) Task<IEnumerable<JsonInvoice>> Gets asynchronously list of all invoices.
[SelectAsync(int page, InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)](#selectasyncint-page-invoicetypeconditioninvoicetypecondition-enum-type-invoicestatusconditioninvoicestatuscondition-enum-status-int-subjectid-datetime-since-string-number) Task<IEnumerable<JsonInvoice>> Gets asynchronously paged list of invoices.
SelectSingle(int id) JsonInvoice Selects single invoice with specified ID.
SelectSingleAsync(int id) Task<JsonInvoice> Selects asynchronously single invoice with specified ID.
[SendMessage(int id, InvoiceMessageType messageType)](#sendmessageint-id-invoicemessagetypeinvoicemessagetype-enum-messagetype) void Sends e-mail message for the specified invoice.
[SendMessageAsync(int id, InvoiceMessageType messageType)](#sendmessageasyncint-id-invoicemessagetypeinvoicemessagetype-enum-messagetype) Task Sends asynchronously e-mail message for the specified invoice.
SetAttachment(int id, string filePath) void Sets attachment for invoice.
SetAttachment(int id, string mimeType, byte[] fileContent) void Sets attachment for invoice.
SetAttachmentAsync(int id, string filePath) Task Sets attachment for invoice.
SetAttachmentAsync(int id, string mimeType, byte[] fileContent) Task Sets attachment for invoice.
[SetPaymentStatus(int id, InvoicePaymentStatus status)](#setpaymentstatusint-id-invoicepaymentstatusinvoicepaymentstatus-enum-status) void Sets the invoice payment status.
[SetPaymentStatus(int id, InvoicePaymentStatus status, DateTime effectiveDate)](#setpaymentstatusint-id-invoicepaymentstatusinvoicepaymentstatus-enum-status-datetime-effectivedate) void Sets the invoice payment status.
[SetPaymentStatusAsync(int id, InvoicePaymentStatus status)](#setpaymentstatusasyncint-id-invoicepaymentstatusinvoicepaymentstatus-enum-status) Task Sets asynchronously the invoice payment status.
[SetPaymentStatusAsync(int id, InvoicePaymentStatus status, DateTime effectiveDate)](#setpaymentstatusasyncint-id-invoicepaymentstatusinvoicepaymentstatus-enum-status-datetime-effectivedate) Task Sets asynchronously the invoice payment status.
[Update(JsonInvoice entity)](#updatejsoninvoicejsoninvoice-class-entity) JsonInvoice Updates the specified invoice.
[UpdateAsync(JsonInvoice entity)](#updateasyncjsoninvoicejsoninvoice-class-entity) Task<JsonInvoice> Updates asynchronously the specified invoice.

Methods

Create(JsonInvoice entity)

Creates the specified new invoice.

Parameter Type Description
entity JsonInvoice The new invoice.

Returns

int

ID of newly created invoice.

CreateAsync(JsonInvoice entity)

Creates asynchronously the specified new invoice.

Parameter Type Description
entity JsonInvoice The new invoice.

Returns

Task

ID of newly created invoice.

Delete(int id)

Deletes invoice with specified id.

Parameter Type Description
id int The contact id.

DeleteAsync(int id)

Deletes asynchronously invoice with specified id.

Parameter Type Description
id int The contact id.

Returns

Task

Select(InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)

Gets list of all invoices.

Parameter Type Description
type InvoiceTypeCondition The invoice type.
status InvoiceStatusCondition The invoice status.
subjectId int? The customer subject id.
since DateTime? The date since when the invoice was created.
number string The invoice display number.

Returns

IEnumerable<JsonInvoice>

List of Altairis.Fakturoid.Client.JsonInvoice instances.

Select(int page, InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)

Gets paged list of invoices.

Parameter Type Description
page int The page number.
type InvoiceTypeCondition The invoice type.
status InvoiceStatusCondition The invoice status.
subjectId int? The customer subject id.
since DateTime? The date since when the invoice was created.
number string The invoice display number.

Returns

IEnumerable<JsonInvoice>

List of Altairis.Fakturoid.Client.JsonInvoice instances.

SelectAsync(InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)

Gets asynchronously list of all invoices.

Parameter Type Description
type InvoiceTypeCondition The invoice type.
status InvoiceStatusCondition The invoice status.
subjectId int? The customer subject id.
since DateTime? The date since when the invoice was created.
number string The invoice display number.

Returns

Task<IEnumerable<JsonInvoice>>

List of Altairis.Fakturoid.Client.JsonInvoice instances.

SelectAsync(int page, InvoiceTypeCondition type, InvoiceStatusCondition status, int? subjectId, DateTime? since, string number)

Gets asynchronously paged list of invoices.

Parameter Type Description
page int The page number.
type InvoiceTypeCondition The invoice type.
status InvoiceStatusCondition The invoice status.
subjectId int? The customer subject id.
since DateTime? The date since when the invoice was created.
number string The invoice display number.

Returns

Task<IEnumerable<JsonInvoice>>

List of Altairis.Fakturoid.Client.JsonInvoice instances.

SelectSingle(int id)

Selects single invoice with specified ID.

Parameter Type Description
id int The invoice id.

Returns

JsonInvoice

Instance of Altairis.Fakturoid.Client.JsonInvoice class.

SelectSingleAsync(int id)

Selects asynchronously single invoice with specified ID.

Parameter Type Description
id int The invoice id.

Returns

Task<JsonInvoice>

Instance of Altairis.Fakturoid.Client.JsonInvoice class.

SendMessage(int id, InvoiceMessageType messageType)

Sends e-mail message for the specified invoice.

Parameter Type Description
id int The invoice id.
messageType InvoiceMessageType Type of the message.

SendMessageAsync(int id, InvoiceMessageType messageType)

Sends asynchronously e-mail message for the specified invoice.

Parameter Type Description
id int The invoice id.
messageType InvoiceMessageType Type of the message.

Returns

Task

SetAttachment(int id, string filePath)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
filePath string The file path.

SetAttachment(int id, string mimeType, byte[] fileContent)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
mimeType string The mime type.
fileContent byte[] The content of the file.

SetAttachmentAsync(int id, string filePath)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
filePath string The file path.

Returns

Task

SetAttachmentAsync(int id, string mimeType, byte[] fileContent)

Sets attachment for invoice.

Parameter Type Description
id int The invoice id.
mimeType string The mime type.
fileContent byte[] The content of the file.

Returns

Task

SetPaymentStatus(int id, InvoicePaymentStatus status)

Sets the invoice payment status.

Parameter Type Description
id int The invoice id.
status InvoicePaymentStatus The new payment status.

SetPaymentStatus(int id, InvoicePaymentStatus status, DateTime effectiveDate)

Sets the invoice payment status.

Parameter Type Description
id int The invoice id.
status InvoicePaymentStatus The new payment status.
effectiveDate DateTime The date when payment was performed.

SetPaymentStatusAsync(int id, InvoicePaymentStatus status)

Sets asynchronously the invoice payment status.

Parameter Type Description
id int The invoice id.
status InvoicePaymentStatus The new payment status.

Returns

Task

Instance of Altairis.Fakturoid.Client.JsonInvoice class with modified entity.

SetPaymentStatusAsync(int id, InvoicePaymentStatus status, DateTime effectiveDate)

Sets asynchronously the invoice payment status.

Parameter Type Description
id int The invoice id.
status InvoicePaymentStatus The new payment status.
effectiveDate DateTime The date when payment was performed.

Returns

Task

Update(JsonInvoice entity)

Updates the specified invoice.

Parameter Type Description
entity JsonInvoice The invoice to update.

Returns

JsonInvoice

Instance of Altairis.Fakturoid.Client.JsonInvoice class with modified entity.

UpdateAsync(JsonInvoice entity)

Updates asynchronously the specified invoice.

Parameter Type Description
entity JsonInvoice The invoice to update.

Returns

Task<JsonInvoice>

Instance of Altairis.Fakturoid.Client.JsonInvoice class with modified entity.

FakturoidSubjectsProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class for working with subjects/contacts.

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
[Create(JsonSubject entity)](#createjsonsubjectjsonsubject-class-entity) int Creates the specified new subject.
[CreateAsync(JsonSubject entity)](#createasyncjsonsubjectjsonsubject-class-entity) Task<int> Creates asynchronously the specified new subject.
Delete(int id) void Deletes subject with specified id.
DeleteAsync(int id) Task Deletes asynchronously with specified id.
Search(string searchTerm) IEnumerable<JsonSubject> Searches all Subjects in Name, Full name, Email, Registration number and Country.
SearchAsync(string searchTerm) Task<IEnumerable<JsonSubject>> Searches asynchronously all Subjects in Name, Full name, Email, Registration number and Country.
Select(string customId) IEnumerable<JsonSubject> Gets list of all subjects.
Select(int page) IEnumerable<JsonSubject> Gets paged list of subjects
SelectAsync(string customId) Task<IEnumerable<JsonSubject>> Gets asynchronously list of all subjects.
SelectAsync(int page) Task<IEnumerable<JsonSubject>> Gets asynchronously paged list of subjects
SelectSingle(int id) JsonSubject Selects single subject with specified ID.
SelectSingleAsync(int id) Task<JsonSubject> Selects asynchronously single subject with specified ID.
[Update(JsonSubject entity)](#updatejsonsubjectjsonsubject-class-entity) JsonSubject Updates the specified subject.
[UpdateAsync(JsonSubject entity)](#updateasyncjsonsubjectjsonsubject-class-entity) Task<JsonSubject> Updates asynchronously the specified subject.

Methods

Create(JsonSubject entity)

Creates the specified new subject.

Parameter Type Description
entity JsonSubject The new subject.

Returns

int

ID of newly created subject.

CreateAsync(JsonSubject entity)

Creates asynchronously the specified new subject.

Parameter Type Description
entity JsonSubject The new subject.

Returns

Task

ID of newly created subject.

Delete(int id)

Deletes subject with specified id.

Parameter Type Description
id int The contact id.

DeleteAsync(int id)

Deletes asynchronously with specified id.

Parameter Type Description
id int The contact id.

Returns

Task

Search(string searchTerm)

Searches all Subjects in Name, Full name, Email, Registration number and Country.

Parameter Type Description
searchTerm string Search string.

Returns

IEnumerable<JsonSubject>

Collection if search results.

SearchAsync(string searchTerm)

Searches asynchronously all Subjects in Name, Full name, Email, Registration number and Country.

Parameter Type Description
searchTerm string Search string.

Returns

Task<IEnumerable<JsonSubject>>

Collection if search results.

Select(string customId)

Gets list of all subjects.

Parameter Type Description
customId string The custom identifier used for filtering.

Returns

IEnumerable<JsonSubject>

List of Altairis.Fakturoid.Client.JsonSubject instances.

Select(int page)

Gets paged list of subjects

Parameter Type Description
page int The page number.

Returns

IEnumerable<JsonSubject>

List of Altairis.Fakturoid.Client.JsonSubject instances.

SelectAsync(string customId)

Gets asynchronously list of all subjects.

Parameter Type Description
customId string The custom identifier used for filtering.

Returns

Task<IEnumerable<JsonSubject>>

List of Altairis.Fakturoid.Client.JsonSubject instances.

SelectAsync(int page)

Gets asynchronously paged list of subjects

Parameter Type Description
page int The page number.

Returns

Task<IEnumerable<JsonSubject>>

List of Altairis.Fakturoid.Client.JsonSubject instances.

SelectSingle(int id)

Selects single subject with specified ID.

Parameter Type Description
id int The subject id.

Returns

JsonSubject

Instance of Altairis.Fakturoid.Client.JsonSubject class.

SelectSingleAsync(int id)

Selects asynchronously single subject with specified ID.

Parameter Type Description
id int The subject id.

Returns

Task<JsonSubject>

Instance of Altairis.Fakturoid.Client.JsonSubject class.

Update(JsonSubject entity)

Updates the specified subject.

Parameter Type Description
entity JsonSubject The subject to update.

Returns

JsonSubject

Instance of Altairis.Fakturoid.Client.JsonSubject class with modified entity.

UpdateAsync(JsonSubject entity)

Updates asynchronously the specified subject.

Parameter Type Description
entity JsonSubject The subject to update.

Returns

Task<JsonSubject>

Instance of Altairis.Fakturoid.Client.JsonSubject class with modified entity.

FakturoidTodosProxy Class

Namespace: Altairis.Fakturoid.Client

Base class: FakturoidEntityProxy

Proxy class for working with todo tasks.

Properties

Name Type Summary
Context FakturoidContext Gets the related context.

Methods

Name Returns Summary
Select(DateTime? since) IEnumerable<JsonTodo> Gets list of all current todos.
Select(int page, DateTime? since) IEnumerable<JsonTodo> Gets paged list of current todos
SelectAsync(DateTime? since) Task<IEnumerable<JsonTodo>> Gets asynchronously list of all current todos.
SelectAsync(int page, DateTime? since) Task<IEnumerable<JsonTodo>> Gets asynchronously paged list of current todos

Methods

Select(DateTime? since)

Gets list of all current todos.

Parameter Type Description
since DateTime? The date since when todos are to be selected.

Returns

IEnumerable<JsonTodo>

List of Altairis.Fakturoid.Client.JsonTodo instances.

Select(int page, DateTime? since)

Gets paged list of current todos

Parameter Type Description
page int The page number.
since DateTime? The date since when todos are to be selected.

Returns

IEnumerable<JsonTodo>

List of Altairis.Fakturoid.Client.JsonTodo instances.

SelectAsync(DateTime? since)

Gets asynchronously list of all current todos.

Parameter Type Description
since DateTime? The date since when todos are to be selected.

Returns

Task<IEnumerable<JsonTodo>>

List of Altairis.Fakturoid.Client.JsonTodo instances.

SelectAsync(int page, DateTime? since)

Gets asynchronously paged list of current todos

Parameter Type Description
page int The page number.
since DateTime? The date since when todos are to be selected.

Returns

Task<IEnumerable<JsonTodo>>

List of Altairis.Fakturoid.Client.JsonTodo instances.

InternalExtensionMethods Class

Namespace: Altairis.Fakturoid.Client

Methods

Name Returns Summary
EnsureFakturoidSuccess(HttpResponseMessage r) void

Methods

EnsureFakturoidSuccess(HttpResponseMessage r)

InvoiceMessageType Enum

Namespace: Altairis.Fakturoid.Client

Type of e-mail message to be sent.

Values

Name Summary
NoMessage Do not actually send anything, just mark invoice as sent
InvoiceMessage Predefined message containing link to invoice
PaymentReminderMessage Predefined message containing payment reminder

InvoicePaymentStatus Enum

Namespace: Altairis.Fakturoid.Client

Invoice payment status

Values

Name Summary
Unpaid Reset payment status to unpaid.
Paid Set status of regular invoice to paid.
ProformaPaid Set status of proforma invoice to paid.
PartialProformaPaid Set status of partial proforma invoice to paid.

InvoiceStatusCondition Enum

Namespace: Altairis.Fakturoid.Client

Query status condition for listing invoices

Values

Name Summary
Any Any
Open Faktura není zaplacena, odeslána ani po splatnosti.
Sent Faktura byla odeslána a není po splatnosti.
Overdue Faktura je po splatnosti.
Paid Faktura je zaplacena.
Cancelled Faktura je stornována (pouze neplátci DPH).

InvoiceTypeCondition Enum

Namespace: Altairis.Fakturoid.Client

Query invoice type condition for listing invoices.

Values

Name Summary
Any Any
Proforma The proforma invouice.
Regular The regular, non-proforma invoice

JsonAccount Class

Namespace: Altairis.Fakturoid.Client

User account information, as received from JSON API.

Properties

Name Type Summary
subdomain string Subdoména
plan string Jméno tarifu
plan_price int Cena tarifu
email string E-mail vlastníka účtu
invoice_email string E-mail, ze kterého jsou odesílány faktury
phone string Telefon vlastníka účtu
web string Web vlastníka účtu
name string Jméno firmy
full_name string Jméno majitele účtu
registration_no string
vat_no string DIČ
vat_mode string Plátce DPH / Neplátce DPH / Identifikovaná osoba
street string Ulice
street2 string Ulice - druhý řádek
city string Místo
zip string PSČ
country string ISO kód země
bank_account string Číslo účtu
iban string Číslo účtu jako IBAN
swift_bic string BIC (pro SWIFT platby)
currency string Měna
unit_name string Výchozí měrná jednotka
vat_rate decimal Výchozí sazba DPH
displayed_note string Text patičky faktury
invoice_note string Text před položkami faktury
due int Výchozí splatnost faktur
custom_email_text string Text emailu pro odeslání faktury
overdue_email_text string Text upomínky o zaplacení
html_url string Adresa účtu v GUI
url string Adresa API
updated_at DateTime Datum poslední úpravy účtu
created_at DateTime Datum vytvoření účtu

JsonAttachment Class

Namespace: Altairis.Fakturoid.Client

User account information, as received from JSON API. Single invoice

Properties

Name Type Summary
file_name string Název souboru
content_type string MIME type souboru
download_url string URL pro download přílohy přes API

JsonBankAccount Class

Namespace: Altairis.Fakturoid.Client

Bank account information, as received from JSON API.

Properties

Name Type Summary
id int Identifikátor bankovního účtu
name string Název účtu
currency string Měna účtu
number string Číslo účtu
iban string Číslo účtu ve formátu IBAN
swift_bic string BIC pro SWIFT platby
pairing bool Povoleno párování plateb
payment_adjustment bool Haléřové vyrovnání pro párování plateb

JsonEntityLine Class

Namespace: Altairis.Fakturoid.Client

Represents single line of entity, as received from JSON API.

Properties

Name Type Summary
name string Název položky
quantity decimal Množství
unit_name string Měrná jednotka
unit_price decimal Jednotková cena
vat_rate decimal Sazba DPH

JsonEvent Class

Namespace: Altairis.Fakturoid.Client

Event, as received from JSON API.

Properties

Name Type Summary
name string Typ události - generated, sent, accepted, sent_reminder, overdue, paid, paid_bank, payment_removed, unpaired_payment
created_at DateTime Datum a čas vytvoření události
invoice_id int? ID faktury (nepovinné)
subject_id int? ID kontaktu (nepovinné)
text string Text události
invoice_url string API adresa faktury (nepovinné)
subject_url string API adresa kontaktu (nepovinné)

JsonExpense Class

Namespace: Altairis.Fakturoid.Client

User account information, as received from JSON API. Single invoice

Properties

Name Type Summary
id int Identifikátor nákladu
custom_id string identifikátor nákladu ve vaší aplikaci
number string číslo nákladu (Př: N20150101, musí odpovídat formátu čísla v nastavení účtu, doplní se automaticky)
original_number string číslo dokladu (uvedené na přijaté faktuře)
variable_symbol string Variabilní symbol
supplier_name string Nazev firmy kontaktu
supplier_street string kontakt ulice
supplier_city string kontakt město
supplier_zip string kontakt PSČ
supplier_country string kontakt země
supplier_registration_no string kontakt IČ
supplier_vat_no string kontakt DIČ
subject_id int ID kontaktu příjemce
status string Stav nákladu - open/overdue/paid
document_type string typ dokumentu - bill/invoice/other
issued_on DateTime? Datum vystavení (zobrazeno na faktuře)
received_on DateTime? Datum přijetí (nepovinné - doplní se dle duzp)
taxable_fulfillment_due DateTime? Datum zdanitelného plnění (nepovinné - doplní se dnes)
due_on DateTime? Datum splatnosti (doplní se podle due)
paid_on DateTime? Datum a čas zaplacení nákladu
description string popis (nepovinné)
private_note string Soukromá poznámka (nepovinné)
tags ICollection<string> Seznam tagů nákladu
bank_account string Číslo bankovního účtu (nepovinné - doplní se z účtu)
iban string IBAN (nepovinné - doplní se z účtu)
swift_bic string BIC (nepovinné - doplní se z účtu)
payment_method string Způsob úhrady: bank (bankovní převod) / cash (hotově) / cod (dobírka)
currency string Kód měny (nepovinné - doplní se z účtu, 3 znaky)
exchange_rate decimal Kurz (nepovinné)
transferred_tax_liability bool Přenesená daňová povinnost
vat_price_mode string Způsob zadávání cen do řádků (hodnoty: null, without_vat, with_vat, default: dle účtu).
Je ignorováno, pokud účet je neplátce DPH nebo je zapnuta přenesená daňová povinnost.
supply_code int? Kód plnění pro souhrnná hlášení (pouze pro zahraniční nákladu do EU, nepovinné)
round_total bool? Zaokrouhlit cenu s DPH při vystavení (nepovinné)
subtotal decimal Součet bez DPH
native_subtotal decimal Součet bez DPH v měně účtu
total decimal Součet včetně DPH
native_total decimal Součet včetně DPH v měně účtu
attachment JsonAttachment Příloha
html_url string Adresa nákladu v GUI
url string API adresa nákladu
pdf_url string API adresa pro stažení nákladu v PDF
subject_url string API adresa kontaktu příjemce
created_at DateTime? Datum vytvoreni nákladu
updated_at DateTime? Datum poslední aktualizace nákladu
lines ICollection<JsonExpenseLine> Položky nákladu

JsonExpenseLine Class

Namespace: Altairis.Fakturoid.Client

Base class: JsonEntityLine

Expense line information, as received from JSON API.

Properties

Name Type Summary
name string Název položky
quantity decimal Množství
unit_name string Měrná jednotka
unit_price decimal Jednotková cena
vat_rate decimal Sazba DPH

JsonInvoice Class

Namespace: Altairis.Fakturoid.Client

User account information, as received from JSON API. Single invoice

Properties

Name Type Summary
id int Identifikátor faktury
proforma bool Příznak proformy
partial_proforma bool? Přiznak zda je proforma na plnou částku
number string Číslo faktury (např.: 2011-0001, musí odpovídat formátu čísla v nastavení účtu)
variable_symbol string Variabilní symbol
your_name string Vaše obchodní jméno
your_street string Vaše ulice
your_street2 string Vaše ulice - druhý řádek
your_city string Vaše město
your_zip string Vaše PSČ
your_country string Vaše země
your_registration_no string Vaše IČ
your_vat_no string Vaše DIČ
client_name string Obchodní jméno příjemce
client_street string Ulice příjemce
client_street2 string Ulice příjemce - druhý řádek
client_city string Místo příjemce
client_zip string PSČ příjemce
client_country string Země příjemce
client_registration_no string IČ příjemce
client_vat_no string DIČ příjemce
subject_id int ID kontaktu příjemce
generator_id int? ID šablony ze které byla faktura vystavena (nepovinné)
related_id int? ID proformy/faktury (nepovinné)
correction bool? Opravný daňový doklad (false = faktura/proforma, nepovinné)
correction_id int? ID opravovaného dokladu, zdává se pouze pokud je correction=true, na opravovaný doklad
se doplní automaticky doplní ID opravného daňového dokladu (nepovinné)
token string Token pro public akci
status string Stav faktury - open/sent/overdue/paid
order_number string Číslo objednávky (nepovinné)
issued_on DateTime? Datum vystavení (zobrazeno na faktuře)
taxable_fulfillment_due DateTime? Datum zdanitelného plnění (nepovinné - doplní se dnes)
due int? Počet dní, než bude po splatnosti (nepovinné - doplní se z účtu)
due_on DateTime? Datum splatnosti (doplní se podle due)
sent_at DateTime? Datum a čas odeslání faktury
paid_at DateTime? Datum a čas zaplacení faktury
reminder_sent_at DateTime? Datum a čas odeslání upomínky
accepted_at DateTime? Datum a čas odsouhlasení faktury klientem
cancelled_at DateTime? Datum stornování faktury (pouze pro neplátce DPH)
note string Text před položkami faktury (nepovinné - doplní se z účtu)
footer_note string Patička faktury (nepovinné - doplní se z účtu)
private_note string Soukromá poznámka (nepovinné)
tags ICollection<string> Seznam tagů faktury
bank_account_id int? ID bankovního účtu (nepovinné - použije se výchozí bankovní účet)
bank_account string Číslo bankovního účtu (nepovinné - doplní se z účtu)
iban string IBAN (nepovinné - doplní se z účtu)
swift_bic string BIC (nepovinné - doplní se z účtu)
payment_method string Způsob úhrady: bank (bankovní převod) / cash (hotově) / cod (dobírka)
currency string Kód měny (nepovinné - doplní se z účtu, 3 znaky)
exchange_rate decimal Kurz (nepovinné)
paypal bool? Tlačítko pro platbu PayPalem - true/false (nepovinné)
language string Jazyk faktury
transferred_tax_liability bool Přenesená daňová povinnost
supply_code int? Kód plnění pro souhrnná hlášení (pouze pro zahraniční faktury do EU, nepovinné)
eu_electronic_service bool? Příznak, pokud je faktura v režimu MOSS (nepovinné)
vat_price_mode string Způsob zadávání cen do řádků (hodnoty: null, without_vat, with_vat, default: dle účtu).
Je ignorováno, pokud účet je neplátce DPH nebo je zapnuta přenesená daňová povinnost.
round_total bool? Zaokrouhlit cenu s DPH při vystavení (nepovinné)
subtotal decimal Součet bez DPH
native_subtotal decimal Součet bez DPH v měně účtu
total decimal Součet včetně DPH
native_total decimal Součet včetně DPH v měně účtu
remaining_amount decimal Částka k zaplacení
remaining_native_amount decimal Částka k zaplacení v měně účtu
attachment JsonAttachment Příloha
html_url string Adresa faktury v GUI
public_html_url string Veřejná HTML adresa faktury
url string API adresa faktury
pdf_url string API adresa pro stažení faktury v PDF
subject_url string API adresa kontaktu příjemce
updated_at DateTime? Datum poslední aktualizace faktury
lines ICollection<JsonInvoiceLine> Položky faktury

JsonInvoiceLine Class

Namespace: Altairis.Fakturoid.Client

Base class: JsonEntityLine

Invoice line information, as received from JSON API.

Properties

Name Type Summary
name string Název položky
quantity decimal Množství
unit_name string Měrná jednotka
unit_price decimal Jednotková cena
vat_rate decimal Sazba DPH

JsonSubject Class

Namespace: Altairis.Fakturoid.Client

Subject (contact), as received from JSON API.

Properties

Name Type Summary
id int Identifikátor kontaktu
custom_id string Vlastní identifikátor kontaktu
name string Obchodní jméno
street string Ulice
street2 string Ulice - druhý řádek
city string Město
zip string PSČ
country string Země
registration_no string
vat_no string DIČ
bank_account string Číslo účtu
iban string Číslo účtu jako IBAN
variable_symbol string Variabilní symbol
full_name string Jméno kontaktní osoby
email string E-mail pro zasílání faktur
email_copy string E-mail pro zasílání kopie faktury
phone string Telefonní číslo
web string Adresa webu
avatar_url string Adresa obrázku kontaktu
html_url string Adresa kontaktu v GUI
url string API adresa kontaktu
updated_at DateTime Datum poslední aktualizace kontaktu

JsonTodo Class

Namespace: Altairis.Fakturoid.Client

Represents a todo task, as received from JSON API.

Properties

Name Type Summary
name string Typ události - initial_todo, initial_fb, already_paid, unpaired_payment, email_bounced
created_at DateTime Datum a čas vytvoření události
completed_at DateTime? Datum a čas odškrtnutí události
invoice_id int? ID faktury
subject_id int? ID kontaktu
text string Text události
invoice_url string API adresa faktury
subject_url string API adresa kontaktu

AllowNullAttribute Class

Namespace: System.Diagnostics.CodeAnalysis

Base class: Attribute

Specifies that null is allowed as an input even if the corresponding type disallows it.

Properties

Name Type Summary
TypeId Object

NotNullWhenAttribute Class

Namespace: System.Diagnostics.CodeAnalysis

Base class: Attribute

Specifies that when a method returns System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue, the parameter will not be null even if the corresponding type allows it.

Properties

Name Type Summary
ReturnValue bool Gets the return value condition.
TypeId Object

Constructors

Name Summary
NotNullWhenAttribute(bool returnValue) Initializes the attribute with the specified return value condition.

Constructors

NotNullWhenAttribute(bool returnValue)

Initializes the attribute with the specified return value condition.

Parameter Type Description
returnValue bool The return value condition. If the method returns this value, the associated parameter will not be null.