GET v2.0/IssuedDocumentPayments/Default/{documentId}

Request Information

Method returns default payment for given document. Returned model is suitable for new payment creation.

Example URL:
 v2.0/IssuedDocumentPayments/Default/{documentId}

URL parameters
Body parameters

Name	Description	Type	Additional information
documentId	Document Id	integer	Required
documentId	Document Id	integer	Required

None.

Response Information

Resource Description
Response Formats

IssuedDocumentPaymentApiModelInsert

Name	Description	Type	Additional information
DateOfPayment	Date of payment	date	None.
DateOfVatApplication	Date of vat application	date	Used in Sk legislation.
ElectronicRecordsOfSales	Electronic records of sales information.	ElectronicRecordsOfSalesApiModel	Used in Cz legislation.
InvoiceId	Document Id	integer	Required
PaymentAmount	Payment ammount	decimal number	None.
PaymentOptionId	Payment option id	integer	None.
SalesPosEquipmentId	POS equipment Id.	integer	Used in Cz legislation.
SendPaymentConfirmation	Send payment confirmation	boolean	None.

application/json, text/json
application/xml, text/xml

Sample:

{
  "ElectronicRecordsOfSales": {
    "EetStatus": null,
    "IsEet": false,
    "RegisteredSale": null,
    "EetResponsibility": 0
  },
  "SalesPosEquipmentId": 1,
  "SendPaymentConfirmation": true,
  "DateOfPayment": "2024-11-07T17:58:31.9946582+00:00",
  "DateOfVatApplication": "2024-11-07T17:58:31.9946582+00:00",
  "Exported": "sample string 3",
  "InvoiceId": 4,
  "PaymentAmount": 5.0,
  "PaymentOptionId": 6
}

Sample:

<IssuedDocumentPaymentApiModelInsert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
  <DateOfPayment>2024-11-07T17:58:31.9946582+00:00</DateOfPayment>
  <DateOfVatApplication>2024-11-07T17:58:31.9946582+00:00</DateOfVatApplication>
  <Exported>sample string 3</Exported>
  <InvoiceId>4</InvoiceId>
  <PaymentAmount>5</PaymentAmount>
  <PaymentOptionId>6</PaymentOptionId>
  <ElectronicRecordsOfSales>
    <EetResponsibility>Idoklad</EetResponsibility>
    <EetStatus i:nil="true" />
    <IsEet>false</IsEet>
    <RegisteredSale i:nil="true" />
  </ElectronicRecordsOfSales>
  <SalesPosEquipmentId>1</SalesPosEquipmentId>
  <SendPaymentConfirmation>true</SendPaymentConfirmation>
</IssuedDocumentPaymentApiModelInsert>