Sage.PL.WebAPI.Interface.Payments.Interfaces Namespace > IPaymentsController Interface > IPaymentsController Methods > GetPDF Method  > GetPDF Method (String, Boolean, Boolean)

| Drukuj

.NET Framework Class Library

IPaymentsController.GetPDF Method (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

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

Assembly:  Sage.PL.WebAPI.Interface.Payments (in Sage.PL.WebAPI.Interface.Payments.dll) Version: 24.2.1.0 (24.2.1.0)

Syntax

Visual Basic

Function GetPDF ( _
 documentNumber As String, _
 Optional buffer As Boolean = False, _
 Optional printNote As Boolean = False _
) As IHttpActionResult

C#

IHttpActionResult GetPDF(
 string documentNumber,
 bool buffer = false,
 bool printNote = false
)

Visual C++

IHttpActionResult^ GetPDF(
 String^ documentNumber,
 bool buffer = false,
 bool printNote = false
)

JavaScript

function getPDF(documentNumber, buffer, printNote);

Parameters

documentNumber

Type: System.String

[FromUri] Numer dokumentu płatności.

buffer (Optional)

Type: System.Boolean

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie wybrany dokument o podanym numerze dokumentu, który nie znajduje się w buforze.

printNote (Optional)

Type: System.Boolean

[FromUri] Czy umieścić notatkę na wydruku PDF. W przypadku, gdy parametr nie zostanie podany notatka nie zostanie umieszczona na wydruku PDF.

Return Value

Zwraca obiekt zawierający skrót dokumentu oraz dokument w Base64 PDF.

See Also

IPaymentsController Interface

IPaymentsController Members

GetPDF Overload

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