Create new document

Time	Status	User Agent
Retrieving recent requests…

Path Params

docType

string

enum

required

Type of document to create

Body Params

doc_date

string

string Document issue date. Format: YYYY-MM-DD. Defaults to current da

brand_uuid

string

If multiple brands exist, specify brand uuid to create document associated with a specific brand. If none provided, the default brand

preview

boolean

Get a preview of the document. No document will be generated if set to true

hide_base_currency

boolean

Whether or not to hide the base currency (usually ILS) in a foreign currency document.

draft

boolean

Create a draft document. No actual document will be generated if set to true

more_info

string

nullable Optional identifier. Will appear at the bottom of the document

close_doc

string

UUID of a previously created document. If supplied, the new document will also close the document indicated by the UUID

cancel_doc

string

UUID of a previously created document. If supplied, the new document will also cancel the document indicated by the UUID

transaction_uuid

string

UUID of a PayPlus transaction

send_document_email

boolean

Send email upon document creation. Will override the whatever's defined in your account

send_document_sms

boolean

send_document_sms

callback_url

string

If valid url is specified, payplus will send a notification to the specified URL upon successful document creation

vatType

string

enum

If omitted, configuration values will be used instead

Allowed:

vat_percentage

integer

Vat percentage to use for calculations. If omitted, configuration values will be used instead

language

string

enum

Allowed:

currency_code

string

conversion_rate

float

If document currency specified is not ILS, this value will be used as the conversion rate for all the prices into the base currency.

autocalculate_rate

boolean

If the conversion rate parameter is omitted, determine conversion rate automatically

prevent_email

boolean

If true, will not send

unique_identifier

string

Arbitrary, unique string. If supplied, the system will refuse further creation attempts if it finds a duplicate, ensuring that this value will always be unique per document.

customer

object

200200

400400