Create a credit invoice for the provided invoice resource ID
Requires the INVOICE.CREDIT.CREATE permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
resourceId
The ID of the resource for which the action is posted.
Headers
x-platform-id
Platform ID.
Request
This endpoint expects an object.
note
periods
forceInitOnHold
delivery_date
groupsDeprecated
Response
OK
object_type
id
invoice_number
purchase_order_number
platform_id
customer_id
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
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
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
billing_entity
status
on_hold
type
created_at
updated_at
invoice_date
delivery_date
due_date
billing_period_date
billing_currency
invoice_amount_including_tax
open_invoice_amount
closed_invoice_amount
paid_invoice_amount
timezone
billing_period
pricing_plan_subscription_ids
pricing_amount_type
Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.
periods
Periods that are applicable for this invoice, use either periods or groups for summation, groups will be removed in later version
closed_periods
tax_categories
tax_summary
dunning_actions
payment_acceptor_ids
payment_actions
pay_invoice_link
notes
linked_invoices
custom_fields
other_custom_fields
credit
e_invoices
used_exchange_rates
processing_only_customers
meter_values
credit_types
display_invoice_sub_lines_per_processing_only_customer
forwarded_from_customers
validation_result
reprocess
used_tax_registration
The tax registrations that are used to calculate the tax for this invoice. If empty, the billing entity was used
footnote
Footnote to be shown on the invoice
approval_status
Approval status for invoices that are associated with an approval request
updated_to_final_at
The invoice finalization date
has_usage_based_pricing
coupons
Coupons applied to this invoice
promotion_codes
Promotion codes applied to this invoice
linked_integrations
billing_type
payment_status
paidDeprecated
auto_rescuesDeprecated
linked_invoices_idsDeprecated
Can currently only be used for ‘ONE_OFF_CREDIT’ invoices, indicates original invoices that this invoice links to
to_be_reprocessedDeprecated
to_be_reprocessed_atDeprecated
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error