C# Class IdokladSdk.Clients.IssuedInvoiceClient

Methods for issued invoice resources.

Inheritance: BaseClient

Mostra file Open project: mholec/idoklad-sdk-csharp

Public Methods

Method	Description
CashVoucherPdf ( int invoiceId ) : string	GET api/IssuedInvoices/{id}/GetCashVoucherPdf Returns Pdf file with Cash voucher report for the invoice. File is Base64 encoded and is returned as string.
CashVoucherPdfCompressed ( int invoiceId ) : string	GET api/IssuedInvoices/{id}/GetCashVoucherPdfCompressed Returns zipped Pdf file with Cash voucher report for the invoice. File is Base64 encoded and is returned as string.
Create ( IssuedInvoiceCreate invoice ) : IssuedInvoice	POST api/IssuedInvoices Create new issued invoice. Invoice should contains only items with ItemTypeNormal.
Default ( ) : IssuedInvoiceCreate	GET api/IssuedInvoices/Default Method returns empty invoice with default values. Returned resource is suitable for new invoice creation.
Delete ( int invoiceId ) : bool	DELETE api/IssuedInvoices/{id} Deletes issued invoice by Id.
FullyPay ( int invoiceId, System.DateTime paid ) : bool	PUT api/IssuedInvoices/{id}/FullyPay?dateOfPayment={dateOfPayment} Method sets invoice as paid.
FullyUnpay ( int invoiceId ) : bool	PUT api/IssuedInvoices/{id}/FullyUnpay Method sets invoice as unpaid.
IssuedInvoice ( int invoiceId ) : IssuedInvoice	GET api/IssuedInvoices/{id} Returns information about issued invoice including summaries.
IssuedInvoiceClient ( ApiContext apiContext ) : System
IssuedInvoiceExpand ( int invoiceId ) : IssuedInvoiceExpand	GET api/IssuedInvoices/{id}/Expand Returns Issued invoice with related entities by Id.
IssuedInvoicePdf ( int invoiceId ) : string	GET api/IssuedInvoices/{id}/GetPdf Returns Pdf file with Issued Invoic. File is Base64 encoded and is returned as string.
IssuedInvoicePdfCompressed ( int invoiceId ) : string	GET api/IssuedInvoices/{id}/GetPdfCompressed Returns zipped Pdf file with Issued Invoice report. File is Base64 encoded and is returned as string.
IssuedInvoices ( IssuedInvoiceFilter filter = null ) : RowsResultWrapper	GET api/IssuedInvoices Returns list of issued invoices. Filters are optional.
IssuedInvoicesByContact ( int contactId, IssuedInvoiceFilter filter = null ) : RowsResultWrapper	GET api/IssuedInvoices/{contactId}/IssuedInvoices Returns invoice list for specific contact.
IssuedInvoicesExpand ( IssuedInvoiceFilter filter = null ) : RowsResultWrapper	GET api/IssuedInvoices/Expand Returns Issued invoice list with related entities such as contact information etc.
MyDocumentAddress ( int invoiceId ) : DocumentAddress	GET api/IssuedInvoices/{id}/MyDocumentAddress Contact information of the supplier for invoice.
PurchaserDocumentAddress ( int invoiceId ) : DocumentAddress	GET api/IssuedInvoices/{id}/PurchaserDocumentAddress Contact information of the purchaser for invoice.
Recount ( IssuedInvoiceCreate invoice ) : IssuedInvoice	POST api/IssuedInvoices/Recount Method recounts summaries of the invoice model for creation. Invoice should contains only items with ItemTypeNormal.
Recount ( int invoiceId, IssuedInvoiceUpdate invoice ) : IssuedInvoice	POST api/IssuedInvoices/{id}/Recount Method recounts summaries of the invoice model for update. Invoice should contains only items with ItemTypeNormal.
SendMailToPurchaser ( int invoiceId ) : bool	PUT api/IssuedInvoices/{id}/SendMailToPurchaser Method sends email with issued invoice to the purchaser.
SendMailToPurchaser ( int invoiceId, ExportedStateEnum state ) : bool	PUT api/IssuedInvoices/{id}/Exported/{value} Method updates Exported property of the invoice.
Update ( int invoiceId, IssuedInvoiceUpdate invoice ) : IssuedInvoice	PUT api/IssuedInvoices/{id} Method updates issued invoice by Id. Also possible to update single preperties of invoice. Invoice should contains only items with ItemTypeNormal.
UpdateMyDocumentAddress ( int invoiceId, DocumentAddress address ) : DocumentAddress	PUT api/IssuedInvoices/{id}/MyDocumentAddress Method Updates contact informations of the supplier.
UpdatePurchaserDocumentAddress ( int invoiceId, DocumentAddress address ) : DocumentAddress	PUT api/IssuedInvoices/{id}/PurchaserDocumentAddress Method Updates contact informations of the purchaser.

Method Details

CashVoucherPdf() public method

GET api/IssuedInvoices/{id}/GetCashVoucherPdf Returns Pdf file with Cash voucher report for the invoice. File is Base64 encoded and is returned as string.

public CashVoucherPdf ( int invoiceId ) : string
invoiceId	int
return	string

CashVoucherPdfCompressed() public method

GET api/IssuedInvoices/{id}/GetCashVoucherPdfCompressed Returns zipped Pdf file with Cash voucher report for the invoice. File is Base64 encoded and is returned as string.

public CashVoucherPdfCompressed ( int invoiceId ) : string
invoiceId	int
return	string

Create() public method

POST api/IssuedInvoices Create new issued invoice. Invoice should contains only items with ItemTypeNormal.

public Create ( IssuedInvoiceCreate invoice ) : IssuedInvoice
invoice	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceCreate
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoice

Default() public method

GET api/IssuedInvoices/Default Method returns empty invoice with default values. Returned resource is suitable for new invoice creation.

public Default ( ) : IssuedInvoiceCreate
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceCreate

Delete() public method

DELETE api/IssuedInvoices/{id} Deletes issued invoice by Id.

public Delete ( int invoiceId ) : bool
invoiceId	int
return	bool

FullyPay() public method

PUT api/IssuedInvoices/{id}/FullyPay?dateOfPayment={dateOfPayment} Method sets invoice as paid.

public FullyPay ( int invoiceId, System.DateTime paid ) : bool
invoiceId	int
paid	System.DateTime
return	bool

FullyUnpay() public method

PUT api/IssuedInvoices/{id}/FullyUnpay Method sets invoice as unpaid.

public FullyUnpay ( int invoiceId ) : bool
invoiceId	int
return	bool

IssuedInvoice() public method

GET api/IssuedInvoices/{id} Returns information about issued invoice including summaries.

public IssuedInvoice ( int invoiceId ) : IssuedInvoice
invoiceId	int
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoice

IssuedInvoiceClient() public method

public IssuedInvoiceClient ( ApiContext apiContext ) : System
apiContext	ApiContext
return	System

IssuedInvoiceExpand() public method

GET api/IssuedInvoices/{id}/Expand Returns Issued invoice with related entities by Id.

public IssuedInvoiceExpand ( int invoiceId ) : IssuedInvoiceExpand
invoiceId	int
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceExpand

IssuedInvoicePdf() public method

GET api/IssuedInvoices/{id}/GetPdf Returns Pdf file with Issued Invoic. File is Base64 encoded and is returned as string.

public IssuedInvoicePdf ( int invoiceId ) : string
invoiceId	int
return	string

IssuedInvoicePdfCompressed() public method

GET api/IssuedInvoices/{id}/GetPdfCompressed Returns zipped Pdf file with Issued Invoice report. File is Base64 encoded and is returned as string.

public IssuedInvoicePdfCompressed ( int invoiceId ) : string
invoiceId	int
return	string

IssuedInvoices() public method

GET api/IssuedInvoices Returns list of issued invoices. Filters are optional.

public IssuedInvoices ( IssuedInvoiceFilter filter = null ) : RowsResultWrapper
filter	IdokladSdk.ApiFilters.IssuedInvoiceFilter
return	RowsResultWrapper

IssuedInvoicesByContact() public method

GET api/IssuedInvoices/{contactId}/IssuedInvoices Returns invoice list for specific contact.

public IssuedInvoicesByContact ( int contactId, IssuedInvoiceFilter filter = null ) : RowsResultWrapper
contactId	int
filter	IdokladSdk.ApiFilters.IssuedInvoiceFilter
return	RowsResultWrapper

IssuedInvoicesExpand() public method

GET api/IssuedInvoices/Expand Returns Issued invoice list with related entities such as contact information etc.

public IssuedInvoicesExpand ( IssuedInvoiceFilter filter = null ) : RowsResultWrapper
filter	IdokladSdk.ApiFilters.IssuedInvoiceFilter
return	RowsResultWrapper

MyDocumentAddress() public method

GET api/IssuedInvoices/{id}/MyDocumentAddress Contact information of the supplier for invoice.

public MyDocumentAddress ( int invoiceId ) : DocumentAddress
invoiceId	int
return	IdokladSdk.ApiModels.DocumentAddress

PurchaserDocumentAddress() public method

GET api/IssuedInvoices/{id}/PurchaserDocumentAddress Contact information of the purchaser for invoice.

public PurchaserDocumentAddress ( int invoiceId ) : DocumentAddress
invoiceId	int
return	IdokladSdk.ApiModels.DocumentAddress

Recount() public method

POST api/IssuedInvoices/Recount Method recounts summaries of the invoice model for creation. Invoice should contains only items with ItemTypeNormal.

public Recount ( IssuedInvoiceCreate invoice ) : IssuedInvoice
invoice	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceCreate
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoice

Recount() public method

POST api/IssuedInvoices/{id}/Recount Method recounts summaries of the invoice model for update. Invoice should contains only items with ItemTypeNormal.

public Recount ( int invoiceId, IssuedInvoiceUpdate invoice ) : IssuedInvoice
invoiceId	int
invoice	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceUpdate
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoice

SendMailToPurchaser() public method

PUT api/IssuedInvoices/{id}/SendMailToPurchaser Method sends email with issued invoice to the purchaser.

public SendMailToPurchaser ( int invoiceId ) : bool
invoiceId	int
return	bool

SendMailToPurchaser() public method

PUT api/IssuedInvoices/{id}/Exported/{value} Method updates Exported property of the invoice.

public SendMailToPurchaser ( int invoiceId, ExportedStateEnum state ) : bool
invoiceId	int
state	ExportedStateEnum
return	bool

Update() public method

PUT api/IssuedInvoices/{id} Method updates issued invoice by Id. Also possible to update single preperties of invoice. Invoice should contains only items with ItemTypeNormal.

public Update ( int invoiceId, IssuedInvoiceUpdate invoice ) : IssuedInvoice
invoiceId	int
invoice	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoiceUpdate
return	IdokladSdk.ApiModels.IssuedInvoice.IssuedInvoice

UpdateMyDocumentAddress() public method

PUT api/IssuedInvoices/{id}/MyDocumentAddress Method Updates contact informations of the supplier.

public UpdateMyDocumentAddress ( int invoiceId, DocumentAddress address ) : DocumentAddress
invoiceId	int
address	IdokladSdk.ApiModels.DocumentAddress
return	IdokladSdk.ApiModels.DocumentAddress

UpdatePurchaserDocumentAddress() public method

PUT api/IssuedInvoices/{id}/PurchaserDocumentAddress Method Updates contact informations of the purchaser.

public UpdatePurchaserDocumentAddress ( int invoiceId, DocumentAddress address ) : DocumentAddress
invoiceId	int
address	IdokladSdk.ApiModels.DocumentAddress
return	IdokladSdk.ApiModels.DocumentAddress