C# Class IdokladSdk.Clients.CreditNoteClient

Methods for credit note resources.
Inheritance: BaseClient
Afficher le fichier Open project: mholec/idoklad-sdk-csharp

Méthodes publiques

Méthode Description
CreditNote ( int creditNoteId ) : CreditNote

GET api/CreditNotes/{id} Returns information about credit note including summaries.

CreditNoteClient ( ApiContext apiContext ) : System
CreditNoteExpand ( int creditNoteId ) : CreditNoteExpand

GET api/CreditNotes/{id}/Expand Returns Credit note with related entities by Id.

CreditNotes ( CreditNoteFilter filter = null ) : RowsResultWrapper

GET api/CreditNotes Returns list of credit notes. Filters are optional.

CreditNotesExpand ( CreditNoteFilter filter = null ) : RowsResultWrapper

GET api/CreditNotes/Expand Returns credit note list with related entities such as contact information etc.

FullyPay ( int creditNoteId, System.DateTime paid ) : bool

PUT api/CreditNotes/{id}/FullyPay?dateOfPayment={dateOfPayment} Method sets credit note as paid.

FullyUnpay ( int creditNoteId ) : bool

PUT api/CreditNotes/{id}/FullyUnpay Method sets credit note as unpaid.

UpdateExported ( int creditNoteId, ExportedStateEnum state ) : bool

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

Method Details

CreditNote() public méthode

GET api/CreditNotes/{id} Returns information about credit note including summaries.
public CreditNote ( int creditNoteId ) : CreditNote
creditNoteId int
Résultat IdokladSdk.ApiModels.CreditNote.CreditNote

CreditNoteClient() public méthode

public CreditNoteClient ( ApiContext apiContext ) : System
apiContext ApiContext
Résultat System

CreditNoteExpand() public méthode

GET api/CreditNotes/{id}/Expand Returns Credit note with related entities by Id.
public CreditNoteExpand ( int creditNoteId ) : CreditNoteExpand
creditNoteId int
Résultat IdokladSdk.ApiModels.CreditNote.CreditNoteExpand

CreditNotes() public méthode

GET api/CreditNotes Returns list of credit notes. Filters are optional.
public CreditNotes ( CreditNoteFilter filter = null ) : RowsResultWrapper
filter IdokladSdk.ApiFilters.CreditNoteFilter
Résultat RowsResultWrapper

CreditNotesExpand() public méthode

GET api/CreditNotes/Expand Returns credit note list with related entities such as contact information etc.
public CreditNotesExpand ( CreditNoteFilter filter = null ) : RowsResultWrapper
filter IdokladSdk.ApiFilters.CreditNoteFilter
Résultat RowsResultWrapper

FullyPay() public méthode

PUT api/CreditNotes/{id}/FullyPay?dateOfPayment={dateOfPayment} Method sets credit note as paid.
public FullyPay ( int creditNoteId, System.DateTime paid ) : bool
creditNoteId int
paid System.DateTime
Résultat bool

FullyUnpay() public méthode

PUT api/CreditNotes/{id}/FullyUnpay Method sets credit note as unpaid.
public FullyUnpay ( int creditNoteId ) : bool
creditNoteId int
Résultat bool

UpdateExported() public méthode

PUT api/CreditNotes/{id}/Exported/{value} Method updates Exported property of the invoice.
public UpdateExported ( int creditNoteId, ExportedStateEnum state ) : bool
creditNoteId int
state ExportedStateEnum
Résultat bool