Sage.PL.WebAPI.Interface.Payments.Interfaces Namespace > IPaymentsController Interface > IPaymentsController Methods

Drukuj

.NET Framework Class Library

IPaymentsController Methods

The IPaymentsController type exposes the following members.

Methods

 

Name

Description

Public method

Get()

Metoda umożliwia pobranie wszystkich dokumentów płatności.

[GET] /api/Payments

Public method

Get(Int32)

Metoda umożliwia pobranie dokumentu płatności o podanym id. Obsługiwane są dokumenty płatności o charakterze: KP, KW, BP, BW, IP, IW, TR+ i TR-.

[GET] /api/Payments?id=id_dokumentu

Public method

Get(String, Boolean)

Metoda umożliwia pobranie dokumentu płatności o podanym numerze dokumentu. Obsługiwane są dokumenty płatności o charakterze: KP, KW, BP, BW, IP, IW, TR+ i TR-.

[GET] /api/Payments?number=numer_dokumentu

Public method

GetBPDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów bankowych i typie wpłaty.

[GET] /api/Payments/BPDocumentTypes

Public method

GetBWDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów bankowych i typie wypłaty.

[GET] /api/Payments/BWDocumentTypes

Public method

GetDocumentSeries

Metoda umożliwia pobranie wszystkich serii dla typu dokumentu o podanym id.

[GET] /api/Payments/DocumentSeries?documentTypeId=id_typu_dokumentu

Public method

GetIPDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów inne i typie wpłaty.

[GET] /api/Payments/IPDocumentTypes

Public method

GetIWDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów inne i typie wypłaty.

[GET] /api/Payments/IWDocumentTypes

Public method

GetKPDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów gotówkowych i typie wpłaty.

[GET] /api/Payments/KPDocumentTypes

Public method

GetKWDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności dla rejestrów gotówkowych i typie wypłaty.

[GET] /api/Payments/KWDocumentTypes

Public method

GetList

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego.

[GET] /api/Payments/Filter?dateFrom=data_od&dateTo=data_do

Public method

GetListByContractor(Int32, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych dla kontrahenta o podanym id.

[GET] /api/Payments/Filter?contractorId=id_kontrahenta&dateFrom=data_od&dateTo=data_do

Public method

GetListByContractor(String, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych dla kontrahenta o podanym kodzie.

[GET] /api/Payments/Filter?contractorCode=kod_kontrahenta&dateFrom=data_od&dateTo=data_do

Public method

GetListByPaymentRegistry(Int32, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych na rejestrze płatności o podanym id.

[GET] /api/Payments/Filter?paymentRegistryId=id_rejestru_platnosci&dateFrom=data_od&dateTo=data_do

Public method

GetListByPaymentRegistry(String, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych na rejestrze płatności o podanym kodzie.

[GET] /api/Payments/Filter?paymentRegistryCode=kod_rejestru_platnosci&dateFrom=data_od&dateTo=data_do

Public method

GetListByReceivingPaymentRegistry(Int32, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych dla rejestru płatności o podanym id.

[GET] /api/Payments/Filter?receivingPaymentRegistryId=id_rejestru_platnosci&dateFrom=data_od&dateTo=data_do

Public method

GetListByReceivingPaymentRegistry(String, Nullable(DateTime), Nullable(DateTime))

Metoda umożliwia pobranie wszystkich dokumentów płatności z podanego przedziału czasowego wystawionych dla rejestru płatności o podanym kodzie.

[GET] /api/Payments/Filter?receivingPaymentRegistryCode=kod_rejestru_platnosci&dateFrom=data_od&dateTo=data_do

Public method

GetNALDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze należności.

[GET] /api/Payments/NALDocumentTypes

Public method

GetPagedDocument

Metoda umożliwia pobranie wszystkich dokumentów płatności z rozłożeniem na strony.

[GET] /api/Payments/Page?page=numer_strony&size=ilosc_obiektów_na_stronie&orderBy=wartość_z_obiektu_enumOrderByType

Public method

GetPDF(Int32, Boolean)

Metoda umożliwia pobranie wydruku PDF dokumentu płatności w Base64, o podanym id. Obsługiwane są dokumenty płatności o charakterze: KP, KW, BP, BW, IP, IW, TR+ i TR-.

[GET] /api/Payments/PDF?documentId=id_dokumentu

Public method

GetPDF(String, Boolean, Boolean)

Metoda umożliwia pobranie wydruku PDF dokumentu płatności zakodowanego w Base64, o podanym numerze. Obsługiwane są dokumenty płatności o charakterze: KP, KW, BP, BW, IP, IW, TR+ i TR-.

[GET] /api/Payments/PDF?documentNumber=numer_dokumentu

Public method

GetTRMinusDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności transfer minus.

[GET] /api/Payments/TRMinusDocumentTypes

Public method

GetTRPlusDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze dokumentu płatności transfer plus.

[GET] /api/Payments/TRPlusDocumentTypes

Public method

GetZOBDocumentTypes

Metoda umożliwia pobranie wszystkich typów dokumentów o charakterze zobowiązania.

[GET] /api/Payments/ZOBDocumentTypes

Public method

IssueKP

Obsolete.

Metoda umożliwia wystawienie dokumentu płatności z rejestrem gotówkowym i typie wpłaty.

[POST] /api/Payments/IssueKP

Public method

IssuePayment

Metoda umożliwia wystawienie dokumentu płatności. Obsługiwane są dokumenty płatności o charakterze: KP, KW, BP, BW, IP i IW.

[POST] /api/Payments/Payment

Public method

IssueTransferMinus

Metoda umożliwia wystawienie dokumentu płatności o charakterze TR-.

[POST] /api/Payments/TransferMinus

Public method

IssueTransferPlus(Int32)

Metoda umożliwia wystawienie dokumentu TR+ do wystawionego dokumentu TR-.

[PUT] /api/Payments/TransferPlus?paymentId=id_dokumentu

Public method

IssueTransferPlus(String)

Metoda umożliwia wystawienie dokumentu TR+ do wystawionego dokumentu TR-.

[PUT] /api/Payments/TransferPlus?paymentNumber=numer_dokumentu

See Also

IPaymentsController Interface

Sage.PL.WebAPI.Interface.Payments.Interfaces Namespace