Requires the INVOICE.UPDATE permission.
Request This endpoint expects an object.
purchase_order_number string or null Optional
customer_id string or null Optional
id of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case
customer_reference string or null Optional format: "^\S+$"0-256 characters
reference of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case
sales_tax_percentage string or null Optional
Sales tax percentage. Needs to be present if both customer and billing entity are US-based. Optional if one of them is US-based
customer object or null Optional
billing_entity_id string Optional
id of the billing entity, can only be provided for a one-off invoice. If not provided, the default of the platform will be used
billing_entity object or null Optional
type enum Optional
Allowed values: STANDARD CREDIT ONE_OFF ONE_OFF_CREDIT
invoice_date datetime Optional
due_date datetime or null Optional
invoice_amount_including_tax object or null Optional
open_invoice_amount object or null Optional
closed_invoice_amount object or null Optional
paid_invoice_amount object or null Optional
billing_period object or null Optional
pricing_amount_type enum Optional
Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.
Allowed values: EXCLUDING_TAX INCLUDING_TAX
periods list of objects Optional
Periods that are applicable for this invoice, use either periods or groups for summation, groups will be removed in later version
tax_summary object or null Optional
payment_acceptor_ids list of strings Optional
pay_invoice_link object Optional
notes list of strings or null Optional
custom_fields list of objects or null Optional
credit object or null Optional
used_tax_registration object or null Optional
The tax registrations that are used to calculate the tax for this invoice. If empty, the billing entity was used
linked_integrations list of objects or null Optional
billing_type enum or null Optional
Allowed values: DEFAULT SELF_BILLING
payment_status enum or null Optional
Allowed values: UNPAID PARTIALLY_PAID PAID OVERPAID
paid boolean or null Optional Deprecated
linked_invoices_ids list of strings Optional Deprecated
Can currently only be used for ‘ONE_OFF_CREDIT’ invoices, indicates original invoices that this invoice links to
Response OK
object_type string or null Optional Read-only
id string or null Optional Read-only
invoice_number string or null Optional Read-only
purchase_order_number string or null Optional
platform_id string or null Optional Read-only
customer_id string or null Optional
id of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case
customer_reference string or null Optional format: "^\S+$"0-256 characters
reference of the customer, can only be provided when creating a one-off invoice, and either id or reference is mandatory in that case
sales_tax_percentage string or null Optional
Sales tax percentage. Needs to be present if both customer and billing entity are US-based. Optional if one of them is US-based
customer object or null Optional
billing_entity object or null Optional
type enum Optional
Allowed values: STANDARD CREDIT ONE_OFF ONE_OFF_CREDIT
created_at string or null Optional Read-only
updated_at string or null Optional Read-only
invoice_date datetime Optional
delivery_date string or null Optional Read-only
due_date datetime or null Optional
billing_period_date string or null Optional Read-only
billing_currency string or null Optional Read-only
invoice_amount_including_tax object or null Optional
open_invoice_amount object or null Optional
closed_invoice_amount object or null Optional
paid_invoice_amount object or null Optional
timezone string or null Optional Read-only
billing_period object or null Optional
pricing_plan_subscription_ids list of strings or null Optional Read-only
pricing_plan_schedule_ids list of strings or null Optional Read-only
The pricing plan schedules this invoice bills for.
pricing_amount_type enum Optional
Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.
Allowed values: EXCLUDING_TAX INCLUDING_TAX
periods list of objects Optional
Periods that are applicable for this invoice, use either periods or groups for summation, groups will be removed in later version
closed_periods list of objects or null Optional Read-only
tax_categories list of objects or null Optional Read-only
tax_summary object or null Optional
dunning_actions list of objects or null Optional Read-only
payment_acceptor_ids list of strings Optional
payment_actions list of objects or null Optional Read-only
pay_invoice_link object Optional
notes list of strings or null Optional
linked_invoices list of objects or null Optional Read-only
custom_fields list of objects or null Optional
other_custom_fields list of objects or null Optional Read-only
credit object or null Optional
e_invoices list of objects or null Optional Read-only
used_exchange_rates list of objects or null Optional Read-only
processing_only_customers list of objects or null Optional Read-only
meter_values list of objects or null Optional Read-only
credit_types list of objects or null Optional Read-only
display_invoice_sub_lines_per_processing_only_customer boolean or null Optional Read-only
show_original_customer_invoice_line boolean or null Optional Read-only
show_tax_per_line_item boolean or null Optional Read-only
forwarded_from_customers list of objects or null Optional Read-only
validation_result list of objects or null Optional Read-only
used_tax_registration object or null Optional
The tax registrations that are used to calculate the tax for this invoice. If empty, the billing entity was used
footnote string or null Optional Read-only
Footnote to be shown on the invoice
approval_status enum or null Optional Read-only
Approval status for invoices that are associated with an approval request
Allowed values: PENDING_REVIEW APPROVED DECLINED CANCELLED
updated_to_final_at string or null Optional Read-only
The invoice finalization date
has_usage_based_pricing boolean or null Optional Read-only
coupons list of objects or null Optional Read-only
Coupons applied to this invoice
promotion_codes list of objects or null Optional Read-only
Promotion codes applied to this invoice
linked_integrations list of objects or null Optional
billing_type enum or null Optional
Allowed values: DEFAULT SELF_BILLING
payment_status enum or null Optional
Allowed values: UNPAID PARTIALLY_PAID PAID OVERPAID
paid boolean or null Optional Deprecated
auto_rescues list of objects or null Optional Read-only Deprecated
linked_invoices_ids list of strings Optional Deprecated
Can currently only be used for ‘ONE_OFF_CREDIT’ invoices, indicates original invoices that this invoice links to
to_be_reprocessed boolean or null Optional Read-only Deprecated
to_be_reprocessed_at string or null Optional Read-only Deprecated
