invoices

Create a one-off invoice or credit invoice

Requires the INVOICE.ONE_OFF.CREATE permission.

post/v{version}/invoices

Request

Base URL: https://test.api.solvimon.com
URL: https://test.api.solvimon.com/v{version}/invoices
Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable

idstring nullable

invoice_numberstring nullable

purchase_order_numberstring nullable

platform_idstring nullable

customer_idstring nullable

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_referencestring nullable

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_percentagestring nullable

Sales tax percentage. Needs to be present if both customer and billing entity are US-based. Optional if one of them is US-based

billing_entity_idstring

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

statusstring

on_holdboolean

paidboolean nullable

type'STANDARD' | 'CREDIT' | 'ONE_OFF' | 'ONE_OFF_CREDIT' required

created_atstring nullable

updated_atstring nullable

invoice_datestring date-time

delivery_datestring nullable

due_datestring date-time nullable

billing_period_datestring nullable

billing_currencystring nullable

timezonestring nullable

pricing_plan_subscription_idsstring[] nullable

pricing_plan_schedule_idsstring[] nullable

The pricing plan schedules this invoice bills for.

pricing_amount_type'EXCLUDING_TAX' | 'INCLUDING_TAX'

Indicates whether the amounts provided, e.g. from the pricing plan, are including or excluding tax.

payment_acceptor_idsstring[]

notesstring[] nullable

linked_invoices_idsstring[]

Can currently only be used for 'ONE_OFF_CREDIT' invoices, indicates original invoices that this invoice links to

display_invoice_sub_lines_per_processing_only_customerboolean nullable

show_original_customer_invoice_lineboolean nullable

show_tax_per_line_itemboolean nullable

to_be_reprocessedboolean nullable

to_be_reprocessed_atstring nullable

footnotestring nullable

Footnote to be shown on the invoice

approval_status'PENDING_REVIEW' | 'APPROVED' | 'DECLINED' | 'CANCELLED'

Approval status for invoices that are associated with an approval request

updated_to_final_atstring nullable

The invoice finalization date

has_usage_based_pricingboolean nullable

billing_type'DEFAULT' | 'SELF_BILLING'

payment_status'UNPAID' | 'PARTIALLY_PAID' | 'PAID' | 'OVERPAID'

Response