API Reference

Preview the PDF

post
https://api.bizyness.fr/recurring_invoices/preview

Generates a PDF preview from the provided recurring invoice payload without creating or updating a persisted recurring invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Recurring scheduling settings shared by recurring business document templates.

string

Execution date of the invoice. When omitted during invoice preparation, Bizyness falls back to the issue date.

string

Due date used to determine when an unpaid invoice becomes overdue.

payment_gateway_ids
array of strings

Identifiers of the payment gateways made available on invoices generated from this recurring template.

payment_gateway_ids
tracking_numbers
array of strings

Shipment tracking numbers associated with the invoice.

tracking_numbers
tracking_carriers
array of strings

Carrier names associated with the invoice tracking numbers.

tracking_carriers
metafields
array of objects

Free-form key/value metadata attached to the resource.

metafields
string

Currency code associated with the resource.

string

Discount amount associated with the resource.

string
enum

Discount type associated with the resource.

Allowed:
string

Rebate rate associated with the resource.

string

Late penalty rate associated with the resource.

string

Identifier of the related activity resource.

string
enum

Template associated with the resource.

Allowed:
string

Shipping amount associated with the resource.

string

Shipping tax rate associated with the resource.

boolean

Whether taxes included is enabled or applicable.

boolean

Whether attachments merged is enabled or applicable.

string

Identifier of the related client resource.

shipping_address
object

Schema describing the Address resource or payload.

string

Subject associated with the resource.

lines_groups
array of objects

List of lines groups associated with the resource.

lines_groups
string

Comment associated with the resource.

boolean

Whether payment conditions included is enabled or applicable.

string
enum

Language associated with the resource.

Allowed:
string

Tax exemption text associated with the resource.

payment_methods
array of strings

List of payment methods associated with the resource.

payment_methods
document_ids
array of strings

List of document ids associated with the resource.

document_ids
lines
array of objects
required

List of lines associated with the resource.

lines*
frequency
object
required

Frequency configuration for a recurring invoice template. When type is custom, both occurrence_type and occurrence_value must be provided.

duration
object
required

Duration configuration for a recurring invoice template.

string
required

First date from which Bizyness starts evaluating the recurrence schedule.

boolean

Whether Bizyness should automatically send generated invoices by email after issuance.

string
enum

Payment term automatically applied to invoices generated from this recurring template.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 29 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/json

Updated 29 days ago