Available sorts are invoice_number, title, date_of_invoice, sum_net, sum_tax, sum_external_costs, sum_gross, created_at, updated_at, computed_fields.<alias>.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title

includestring

Available includes are external_costs, line_items, discounts. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

Default 30

page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

Field	Type	Operators
`archived`	`enum: with, only, without`	eq
`title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`status`	`enum<OutgoingInvoiceStatus>`	eq, ne, neq, in, nin, notin
`payment_status`	`enum<OutgoingInvoicePaymentStatus>`	eq, ne, neq, in, nin, notin
`invoice_number`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`is_credit`	`boolean`	eq, ne, neq, isnull, isnotnull, notnull
`date_of_invoice`	`date`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`payment_due_date`	`date`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`sum_net`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`sum_tax`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`sum_gross`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`editor.id`	`id<UserData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`editor.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`editor.email`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.id`	`id<ClientData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`client.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.shortcode`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.id`	`id<ProjectData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`project.title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.shortcode`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`company.id`	`id<CompanyData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`company.company_name:string`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`line_items`	`Relation` - title (string) - price (currency) - amount (float) - project.id (id) - project.title (string) - project.external_id (string) - project.shortcode (string) - total_net (currency) - total_net_base (currency) - total_net_without_discount (currency) - total_gross (currency) - total_gross_base (currency) - total_gross_without_discount (currency) - purchase_total (currency) - purchase_total_base (currency) - type (enum)	any, none, count, all
`external_costs`	`Relation` - title (string) - amount (float) - project.id (id) - project.title (string) - project.external_id (string) - project.shortcode (string) - supplier.id (id) - supplier.name (string) - price (currency) - total (currency)	any, none, count, all

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
now — current date-time. Example: dueOn lt now
sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
today±Nd — relative day offset. Examples: today-30d, today+5d.

Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")

computed_fields[alias]string

Dynamic computed relation fields (computed_fields[alias])

Declare ad-hoc aggregates per request using: computed_fields[<alias>] = relation.aggregate(args)

Syntax:

Count: relation.count() or relation.count(<where>)
Sum/Avg/Min/Max: relation.sum(<column>) or relation.sum(<column>, <where>)

Where is written using the same Filter DSL and is validated against the relation's allowed fields.

Use the prefix computed_fields. when referencing these aliases in filter or sort, e.g., filter=computed_fields.tasks_done gte 1 or sort=-computed_fields.tasks_done. Bare aliases are accepted for backward compatibility but deprecated.

Allowed relations for computed_fields (deny-all by default):

line_items (→ lineItems): aggregates: count, sum, avg, min, max; coalesce default: 0
external_costs (→ internalCosts): aggregates: count, sum, avg, min, max; coalesce default: 0

Example: ?computed_fields[tasks_done]=tasks.count(status%20eq%20%22Completed%22)&filter=computed_fields.tasks_done%20gt%200

Example: computed_fields[alias]=computed_fields[tasks_done]=tasks.count(status%20eq%20%22Completed%22)

curl -i -X GET \
  'https://api.kanbert.com/api/v1/outgoing-invoices?sort=sort%3D-created_at%2Ctitle&include=string&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29&computed_fields%5Balias%5D=computed_fields%5Btasks_done%5D%3Dtasks.count%28status%2520eq%2520%2522Completed%2522%29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of OutgoingInvoiceData

Bodyapplication/json

dataArray of objects(OutgoingInvoiceData)required

The list of items

data[].idstringrequired

data[].external_idstring or nullrequired

data[].external_originstring or nullrequired

data[].master_invoice_idstring or null(OutgoingInvoiceMasterData)required

If invoice is part of a master invoice plan

data[].invoice_numberstring or nullrequired

data[].titlestringrequired

data[].statusstring(OutgoingInvoiceStatus)required


`estimate` Invoice is meant as estimate
`open` Invoice in draft
`bookable` Invoice is ready to be booked
`booked` Invoice was booked

Enum"estimate""open""bookable""booked"

data[].payment_statusstring(OutgoingInvoicePaymentStatus)required

Enum"open""partly_paid""paid""cancelled"

data[].is_creditbooleanrequired

Default false

data[].date_of_invoicestring(date-time)required

data[].payment_due_datestring(date-time)required

data[].payment_due_date_orgstring(date-time)required

Is the payment due date originally set

data[].performance_range_startstring or null(date-time)required

data[].performance_range_endstring or null(date-time)required

data[].po_numberstring or nullrequired

data[].referencestring or nullrequired

data[].localestringrequired

data[].currencystringrequired

data[].addressstringrequired

data[].address_changedbooleanrequired

If true the user manually overwrote the companies address

data[].companyCompanyData (object) or nullrequired

Any of:

data[].company.idstringrequired

data[].company.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].company.external_originstring or nullrequired

If originated from external system origin is added

data[].company.vendor_identifierstring or nullrequired

data[].company.company_namestring or nullrequired

data[].company.localestring or nullrequired

data[].company.tax_uidstring or nullrequired

data[].company.taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

data[].company.ibanstring or nullrequired

data[].company.bicstring or nullrequired

data[].company.emailstring or nullrequired

data[].company.email_generalstring or nullrequired

data[].company.phonestring or nullrequired

data[].company.faxstring or nullrequired

data[].company.homepagestring or nullrequired

data[].company.invoices_by_postbooleanrequired

Default false

data[].company.invoices_by_emailbooleanrequired

Default false

data[].company.business_fieldBusinessFieldData (object) or nullrequired

Any of:

data[].company.business_field.idstringrequired

data[].company.business_field.namestringrequired

data[].company.company_sizeTagData (object) or nullrequired

Any of:

data[].company.company_size.idstringrequired

data[].company.company_size.titlestringrequired

data[].company.company_revenueTagData (object) or nullrequired

Any of:

data[].company.company_revenue.idstringrequired

data[].company.company_revenue.titlestringrequired

data[].company.person_attention_tostring or nullrequired

data[].company.address_invoice_titlestring or nullrequired

data[].company.address_invoice_streetstring or nullrequired

data[].company.address_invoice_housestring or nullrequired

data[].company.address_invoice_street2string or nullrequired

data[].company.address_invoice_zipstring or nullrequired

data[].company.address_invoice_statestring or nullrequired

data[].company.address_invoice_townstring or nullrequired

data[].company.address_invoice_countryCountryData (object) or nullrequired

Any of:

data[].company.address_invoice_country.idstringrequired

data[].company.address_invoice_country.namestringrequired

data[].company.address_invoice_country.codestring(ISO 3166-1 alpha-2)required

data[].company.address_invoice_is_deliverybooleanrequired

data[].company.delivery_person_attention_tostring or nullrequired

data[].company.address_delivery_titlestring or nullrequired

data[].company.address_delivery_streetstring or nullrequired

data[].company.address_delivery_housestring or nullrequired

data[].company.address_delivery_street2string or nullrequired

data[].company.address_delivery_zipstring or nullrequired

data[].company.address_delivery_statestring or nullrequired

data[].company.address_delivery_townstring or nullrequired

data[].company.address_delivery_countryCountryData (object) or nullrequired

Any of:

data[].company.address_delivery_country.idstringrequired

data[].company.address_delivery_country.namestringrequired

data[].company.address_delivery_country.codestring(ISO 3166-1 alpha-2)required

data[].company.clientClientData (object) or nullrequired

Any of:

data[].company.client.idstringrequired

data[].company.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].company.client.external_originstring or nullrequired

If originated from external system origin is added

data[].company.client.namestringrequired

data[].company.client.shortcodestring or nullrequired

data[].company.client.primary_contactUserData (object) or nullrequired

Any of:

data[].company.client.primary_contact.idstringrequired

data[].company.client.primary_contact.first_namestringrequired

data[].company.client.primary_contact.last_namestringrequired

data[].company.client.primary_contact.emailstringrequired

data[].company.client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].company.client.primary_contact.spaceobject(SpaceData)required

data[].company.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].company.client.origin_space.idstringrequired

data[].company.client.origin_space.namestringrequired

data[].company.tagsArray of objects(TagData)

data[].company.contactsArray of objects(ContactData)

data[].company.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].company.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].company.created_atstring(date-time)required

data[].company.updated_atstring or null(date-time)required

data[].company.deleted_atstring or null(date-time)required

data[].company.contact_companyobject(ContactCompanyPivotData)

Added included via relationship (contact -> companies or company -> contacts)

data[].editorUserData (object) or nullrequired

Any of:

data[].editor.idstringrequired

data[].editor.first_namestringrequired

data[].editor.last_namestringrequired

data[].editor.emailstringrequired

data[].editor.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].editor.spaceobject(SpaceData)required

data[].editor.space.idstringrequired

data[].editor.space.namestringrequired

data[].clientobject(ClientData)required

data[].client.idstringrequired

data[].client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].client.external_originstring or nullrequired

If originated from external system origin is added

data[].client.namestringrequired

data[].client.shortcodestring or nullrequired

data[].client.primary_contactUserData (object) or nullrequired

Any of:

data[].client.primary_contact.idstringrequired

data[].client.primary_contact.first_namestringrequired

data[].client.primary_contact.last_namestringrequired

data[].client.primary_contact.emailstringrequired

data[].client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].client.primary_contact.spaceobject(SpaceData)required

data[].client.primary_contact.space.idstringrequired

data[].client.primary_contact.space.namestringrequired

data[].client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].client.origin_space.idstringrequired

data[].client.origin_space.namestringrequired

data[].projectProjectData (object) or nullrequired

Any of:

data[].project.idstringrequired

data[].project.external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

data[].project.external_originstring or nullrequired

If originated from external system origin is added

data[].project.titlestringrequired

data[].project.shortcodestringrequired

data[].project.po_numberstring or nullrequired

data[].project.project_typeobject(ProjectTypeData)required

data[].project.project_type.idstringrequired

data[].project.project_type.titlestringrequired

data[].project.project_type.shortcodestringrequired

data[].project.project_type.colorstringrequired

data[].project.project_type.orderintegerrequired

data[].project.project_type.is_defaultbooleanrequired

data[].project.statusstringrequired

data[].project.is_acquisitionbooleanrequired

data[].project.is_privatebooleanrequired

data[].project.start_datestring or null(date)required

data[].project.end_datestring or null(date)required

data[].project.clientobject(ClientData)required

data[].project.client.idstringrequired

data[].project.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].project.client.external_originstring or nullrequired

If originated from external system origin is added

data[].project.client.namestringrequired

data[].project.client.shortcodestring or nullrequired

data[].project.client.primary_contactUserData (object) or nullrequired

Any of:

data[].project.client.primary_contact.idstringrequired

data[].project.client.primary_contact.first_namestringrequired

data[].project.client.primary_contact.last_namestringrequired

data[].project.client.primary_contact.emailstringrequired

data[].project.client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].project.client.primary_contact.spaceobject(SpaceData)required

data[].project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].project.client.origin_space.idstringrequired

data[].project.client.origin_space.namestringrequired

data[].project.tagsArray of objects(ProjectTagData)

data[].project.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].project.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the project is shared from, if null project is not shared

data[].project.origin_space.idstringrequired

data[].project.origin_space.namestringrequired

data[].project.teamArray of objects(TeamMemberData)

Project team

data[].project.guestsArray of objects(TeamMemberData)

Project guests

data[].project.computed_fieldsobject

data[].taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

data[].sum_netnumberrequired

data[].sum_taxnumberrequired

data[].sum_grossnumberrequired

data[].sum_external_costsnumberrequired

data[].partial_indentstring or nullrequired

Indicator for partial invoices <currentInvoice>/<numberOfInvoices>

data[].partial_factornumber or nullrequired

Factor in percentage for partial invoices

data[].payment_discount_due_datestring or null(date-time)required

data[].payment_discountnumber or nullrequired

Factor in percentage

data[].discountsArray of objects(DiscountData)required

data[].discounts[].idstringrequired

data[].discounts[].titlestringrequired

data[].discounts[].discount_factornumber or nullrequired

Discount in percent

data[].discounts[].discount_absolutenumber or nullrequired

Is not calculated with invoices partial_factor in mind

data[].discounts[].from_parentbooleanrequired

If true, the discount was set in invoice master

data[].discounts[].is_payment_discountbooleanrequired

If true this discount was granted due to payment discount rules

data[].discounts[].orderintegerrequired

The order how discounts are applied

data[].line_itemsArray of objects(OutgoingInvoiceLineItemData)required

data[].line_items[].idstringrequired

data[].line_items[].titlestringrequired

data[].line_items[].typestring(AccountingLineItemType)required

Enum"unit""category""page_break"

data[].line_items[].indentintegerrequired

data[].line_items[].orderintegerrequired

data[].line_items[].pricenumberrequired

Is always the full price of the unit (without partial_factor) See partial_factor if element is part of an partial invoice

data[].line_items[].amountnumberrequired

data[].line_items[].total_net_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_net_without_discountnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_netnumberrequired

Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

data[].line_items[].total_gross_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_gross_without_discountnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_grossnumberrequired

Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

data[].line_items[].tax_factornumberrequired

data[].line_items[].metricobject(MetricData)required

data[].line_items[].metric.idstringrequired

data[].line_items[].metric.titlestringrequired

data[].line_items[].metric.title_pluralstringrequired

data[].line_items[].projectProjectData (object) or nullrequired

Any of:

data[].line_items[].project.idstringrequired

data[].line_items[].project.external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

data[].line_items[].project.external_originstring or nullrequired

If originated from external system origin is added

data[].line_items[].project.titlestringrequired

data[].line_items[].project.shortcodestringrequired

data[].line_items[].project.po_numberstring or nullrequired

data[].line_items[].project.project_typeobject(ProjectTypeData)required

data[].line_items[].project.project_type.idstringrequired

data[].line_items[].project.project_type.titlestringrequired

data[].line_items[].project.project_type.shortcodestringrequired

data[].line_items[].project.project_type.colorstringrequired

data[].line_items[].project.project_type.orderintegerrequired

data[].line_items[].project.project_type.is_defaultbooleanrequired

data[].line_items[].project.statusstringrequired

data[].line_items[].project.is_acquisitionbooleanrequired

data[].line_items[].project.is_privatebooleanrequired

data[].line_items[].project.start_datestring or null(date)required

data[].line_items[].project.end_datestring or null(date)required

data[].line_items[].project.clientobject(ClientData)required

data[].line_items[].project.client.idstringrequired

data[].line_items[].project.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].line_items[].project.client.external_originstring or nullrequired

If originated from external system origin is added

data[].line_items[].project.client.namestringrequired

data[].line_items[].project.client.shortcodestring or nullrequired

data[].line_items[].project.client.primary_contactUserData (object) or nullrequired

Any of:

data[].line_items[].project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].line_items[].project.tagsArray of objects(ProjectTagData)

data[].line_items[].project.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].line_items[].project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].line_items[].project.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the project is shared from, if null project is not shared

data[].line_items[].project.origin_space.idstringrequired

data[].line_items[].project.origin_space.namestringrequired

data[].line_items[].project.teamArray of objects(TeamMemberData)

Project team

data[].line_items[].project.guestsArray of objects(TeamMemberData)

Project guests

data[].line_items[].project.computed_fieldsobject

data[].line_items[].partial_factorinteger or nullrequired

Value in percent. Describes the part of the unit that is included in the invoice

data[].line_items[].exclude_from_discountbooleanrequired

If true, the unit will be excluded from offer-wide discounts

Default false

data[].line_items[].discount_factornumber or nullrequired

data[].line_items[].discount_absolutenumber or nullrequired

data[].line_items[].discount_boundbooleanrequired

If true, the amount will multiply discount absolute

Default false

data[].line_items[].purchase_pricenumberrequired

Default 0

data[].line_items[].purchase_amountnumberrequired

Default 1

data[].line_items[].purchase_total_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

Default 0

data[].line_items[].purchase_totalnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

Default 0

data[].line_items[].purchase_price_boundbooleanrequired

If true, purchase_amount will be in sync with amount

Default false

data[].line_items[].descriptionstringrequired

data[].line_items[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

data[].line_items[].payment_partial_intervalinteger or nullrequired

Interval if payment partial type is monthly or `yearly

Type	Interval	Description
`once`	`any`	Once per offer
`monthly`	`1`	Every month in performance range
`monthly`	`3`	Every 3 months in performance range
`monthly`	`6`	Every 6 monthsin performance range
`yearly`	`1`	Every year in performance range
`yearly`	`3`	Every 3 years in performance range
`yearly`	`6`	Every 6 years in performance range

data[].external_costsArray of objects(ExternalCostData)required

For partial invoices external costs will be empty - these are part of the invoice master plan

data[].external_costs[].idstringrequired

data[].external_costs[].titlestringrequired

data[].external_costs[].typestringrequired

data[].external_costs[].indentintegerrequired

data[].external_costs[].orderintegerrequired

data[].external_costs[].is_creditbooleanrequired

if true this cost is a credit

data[].external_costs[].is_optionalbooleanrequired

data[].external_costs[].pricenumberrequired

data[].external_costs[].amountnumberrequired

data[].external_costs[].totalnumberrequired

data[].external_costs[].supplierSupplierData (object) or nullrequired

Any of:

data[].external_costs[].supplier.idstringrequired

data[].external_costs[].supplier.namestringrequired

data[].external_costs[].clientClientData (object) or nullrequired

Any of:

data[].external_costs[].client.idstringrequired

data[].external_costs[].client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].external_costs[].client.external_originstring or nullrequired

If originated from external system origin is added

data[].external_costs[].client.namestringrequired

data[].external_costs[].client.shortcodestring or nullrequired

data[].external_costs[].client.primary_contactUserData (object) or nullrequired

Any of:

data[].external_costs[].client.primary_contact.idstringrequired

data[].external_costs[].client.primary_contact.first_namestringrequired

data[].external_costs[].client.primary_contact.last_namestringrequired

data[].external_costs[].client.primary_contact.emailstringrequired

data[].external_costs[].client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].external_costs[].client.primary_contact.spaceobject(SpaceData)required

data[].external_costs[].client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].external_costs[].client.origin_space.idstringrequired

data[].external_costs[].client.origin_space.namestringrequired

data[].external_costs[].projectProjectData (object) or nullrequired

Any of:

data[].external_costs[].project.idstringrequired

data[].external_costs[].project.external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

data[].external_costs[].project.external_originstring or nullrequired

If originated from external system origin is added

data[].external_costs[].project.titlestringrequired

data[].external_costs[].project.shortcodestringrequired

data[].external_costs[].project.po_numberstring or nullrequired

data[].external_costs[].project.project_typeobject(ProjectTypeData)required

data[].external_costs[].project.project_type.idstringrequired

data[].external_costs[].project.project_type.titlestringrequired

data[].external_costs[].project.project_type.shortcodestringrequired

data[].external_costs[].project.project_type.colorstringrequired

data[].external_costs[].project.project_type.orderintegerrequired

data[].external_costs[].project.project_type.is_defaultbooleanrequired

data[].external_costs[].project.statusstringrequired

data[].external_costs[].project.is_acquisitionbooleanrequired

data[].external_costs[].project.is_privatebooleanrequired

data[].external_costs[].project.start_datestring or null(date)required

data[].external_costs[].project.end_datestring or null(date)required

data[].external_costs[].project.clientobject(ClientData)required

data[].external_costs[].project.client.idstringrequired

data[].external_costs[].project.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].external_costs[].project.client.external_originstring or nullrequired

If originated from external system origin is added

data[].external_costs[].project.client.namestringrequired

data[].external_costs[].project.client.shortcodestring or nullrequired

data[].external_costs[].project.client.primary_contactUserData (object) or nullrequired

Any of:

data[].external_costs[].project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].external_costs[].project.tagsArray of objects(ProjectTagData)

data[].external_costs[].project.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].external_costs[].project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].external_costs[].project.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the project is shared from, if null project is not shared

data[].external_costs[].project.origin_space.idstringrequired

data[].external_costs[].project.origin_space.namestringrequired

data[].external_costs[].project.teamArray of objects(TeamMemberData)

Project team

data[].external_costs[].project.guestsArray of objects(TeamMemberData)

Project guests

data[].external_costs[].project.computed_fieldsobject

data[].external_costs[].statusstring or nullrequired

data[].external_costs[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

data[].external_costs[].payment_partial_intervalinteger or nullrequired

Interval if payment partial type is monthly or `yearly

Type	Interval	Description
`once`	`any`	Once per offer
`monthly`	`1`	Every month in performance range
`monthly`	`3`	Every 3 months in performance range
`monthly`	`6`	Every 6 monthsin performance range
`yearly`	`1`	Every year in performance range
`yearly`	`3`	Every 3 years in performance range
`yearly`	`6`	Every 6 years in performance range

data[].external_costs[].created_atstring(date-time)required

data[].external_costs[].updated_atstring or null(date-time)required

data[].created_atstring(date-time)required

data[].updated_atstring or null(date-time)required

data[].deleted_atstring or null(date-time)required

data[].computed_fieldsobject

linksArray of stringsrequired

metaobjectrequired

meta.pathstring or nullrequired

Base path for paginator generated URLs.

meta.per_pageintegerrequired

Number of items shown per page.

meta.next_cursorstring or nullrequired

meta.next_cursor_urlstring or nullrequired

meta.prev_cursorstring or nullrequired

meta.prev_cursor_urlstring or nullrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

List all invoice master plans

Request

Required scopes: outgoing-invoice:read

Security

http or oauth2

Query

sortstring

Available sorts are title, performance_range_start, performance_range_end, sum_net, sum_tax, sum_external_costs, sum_gross, created_at, updated_at, computed_fields.<alias>.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title

includestring

Available includes are external_costs, line_items, discounts. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

Default 30

page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

Field	Type	Operators
`archived`	`enum: with, only, without`	eq
`title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`sum_net`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`sum_tax`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`sum_gross`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`editor.id`	`id<UserData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`editor.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`editor.email`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.id`	`id<ClientData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`client.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.shortcode`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.id`	`id<ProjectData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`project.title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`project.shortcode`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`company.id`	`id<CompanyData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`company.company_name:string`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`line_items`	`Relation` - title (string) - price (currency) - amount (float) - project.id (id) - project.title (string) - project.external_id (string) - project.shortcode (string) - total_net (currency) - total_net_base (currency) - total_net_without_discount (currency) - total_gross (currency) - total_gross_base (currency) - total_gross_without_discount (currency) - purchase_total (currency) - purchase_total_base (currency) - type (enum)	any, none, count, all
`external_costs`	`Relation` - title (string) - amount (float) - project.id (id) - project.title (string) - project.external_id (string) - project.shortcode (string) - supplier.id (id) - supplier.name (string) - price (currency) - total (currency)	any, none, count, all

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
now — current date-time. Example: dueOn lt now
sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
today±Nd — relative day offset. Examples: today-30d, today+5d.

Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")

computed_fields[alias]string

Dynamic computed relation fields (computed_fields[alias])

Declare ad-hoc aggregates per request using: computed_fields[<alias>] = relation.aggregate(args)

Syntax:

Count: relation.count() or relation.count(<where>)
Sum/Avg/Min/Max: relation.sum(<column>) or relation.sum(<column>, <where>)

Where is written using the same Filter DSL and is validated against the relation's allowed fields.

Allowed relations for computed_fields (deny-all by default):

line_items (→ lineItems): aggregates: count, sum, avg, min, max; coalesce default: 0
external_costs (→ internalCosts): aggregates: count, sum, avg, min, max; coalesce default: 0

Example: ?computed_fields[tasks_done]=tasks.count(status%20eq%20%22Completed%22)&filter=computed_fields.tasks_done%20gt%200

Example: computed_fields[alias]=computed_fields[tasks_done]=tasks.count(status%20eq%20%22Completed%22)

curl -i -X GET \
  'https://api.kanbert.com/api/v1/outgoing-invoices/master?sort=sort%3D-created_at%2Ctitle&include=string&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29&computed_fields%5Balias%5D=computed_fields%5Btasks_done%5D%3Dtasks.count%28status%2520eq%2520%2522Completed%2522%29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of OutgoingInvoiceMasterData

Bodyapplication/json

dataArray of objects(OutgoingInvoiceMasterData)required

The list of items

data[].idstringrequired

data[].titlestringrequired

data[].typestring(OutgoingInvoiceMasterType)required


`once` If type is once, then the master is a partial plan
`recurring1` Recurring every month
`recurring3` Recurring every 3 months
`recurring6` Recurring every 6 months
`recurring12` Recurring every 12 months

Enum"once""recurring1""recurring3""recurring6""recurring12"

data[].performance_range_startstring or null(date-time)required

data[].performance_range_endstring or null(date-time)required

data[].localestringrequired

data[].currencystringrequired

data[].addressstringrequired

data[].address_changedbooleanrequired

If true the user manually overwrote the companies address

data[].companyCompanyData (object) or nullrequired

Any of:

data[].company.idstringrequired

data[].company.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].company.external_originstring or nullrequired

If originated from external system origin is added

data[].company.vendor_identifierstring or nullrequired

data[].company.company_namestring or nullrequired

data[].company.localestring or nullrequired

data[].company.tax_uidstring or nullrequired

data[].company.taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

data[].company.ibanstring or nullrequired

data[].company.bicstring or nullrequired

data[].company.emailstring or nullrequired

data[].company.email_generalstring or nullrequired

data[].company.phonestring or nullrequired

data[].company.faxstring or nullrequired

data[].company.homepagestring or nullrequired

data[].company.invoices_by_postbooleanrequired

Default false

data[].company.invoices_by_emailbooleanrequired

Default false

data[].company.business_fieldBusinessFieldData (object) or nullrequired

Any of:

data[].company.business_field.idstringrequired

data[].company.business_field.namestringrequired

data[].company.company_sizeTagData (object) or nullrequired

Any of:

data[].company.company_size.idstringrequired

data[].company.company_size.titlestringrequired

data[].company.company_revenueTagData (object) or nullrequired

Any of:

data[].company.company_revenue.idstringrequired

data[].company.company_revenue.titlestringrequired

data[].company.person_attention_tostring or nullrequired

data[].company.address_invoice_titlestring or nullrequired

data[].company.address_invoice_streetstring or nullrequired

data[].company.address_invoice_housestring or nullrequired

data[].company.address_invoice_street2string or nullrequired

data[].company.address_invoice_zipstring or nullrequired

data[].company.address_invoice_statestring or nullrequired

data[].company.address_invoice_townstring or nullrequired

data[].company.address_invoice_countryCountryData (object) or nullrequired

Any of:

data[].company.address_invoice_country.idstringrequired

data[].company.address_invoice_country.namestringrequired

data[].company.address_invoice_country.codestring(ISO 3166-1 alpha-2)required

data[].company.address_invoice_is_deliverybooleanrequired

data[].company.delivery_person_attention_tostring or nullrequired

data[].company.address_delivery_titlestring or nullrequired

data[].company.address_delivery_streetstring or nullrequired

data[].company.address_delivery_housestring or nullrequired

data[].company.address_delivery_street2string or nullrequired

data[].company.address_delivery_zipstring or nullrequired

data[].company.address_delivery_statestring or nullrequired

data[].company.address_delivery_townstring or nullrequired

data[].company.address_delivery_countryCountryData (object) or nullrequired

Any of:

data[].company.address_delivery_country.idstringrequired

data[].company.address_delivery_country.namestringrequired

data[].company.address_delivery_country.codestring(ISO 3166-1 alpha-2)required

data[].company.clientClientData (object) or nullrequired

Any of:

data[].company.client.idstringrequired

data[].company.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].company.client.external_originstring or nullrequired

If originated from external system origin is added

data[].company.client.namestringrequired

data[].company.client.shortcodestring or nullrequired

data[].company.client.primary_contactUserData (object) or nullrequired

Any of:

data[].company.client.primary_contact.idstringrequired

data[].company.client.primary_contact.first_namestringrequired

data[].company.client.primary_contact.last_namestringrequired

data[].company.client.primary_contact.emailstringrequired

data[].company.client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].company.client.primary_contact.spaceobject(SpaceData)required

data[].company.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].company.client.origin_space.idstringrequired

data[].company.client.origin_space.namestringrequired

data[].company.tagsArray of objects(TagData)

data[].company.contactsArray of objects(ContactData)

data[].company.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].company.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].company.created_atstring(date-time)required

data[].company.updated_atstring or null(date-time)required

data[].company.deleted_atstring or null(date-time)required

data[].company.contact_companyobject(ContactCompanyPivotData)

Added included via relationship (contact -> companies or company -> contacts)

data[].editorUserData (object) or nullrequired

Any of:

data[].editor.idstringrequired

data[].editor.first_namestringrequired

data[].editor.last_namestringrequired

data[].editor.emailstringrequired

data[].editor.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].editor.spaceobject(SpaceData)required

data[].editor.space.idstringrequired

data[].editor.space.namestringrequired

data[].clientClientData (object) or nullrequired

Any of:

data[].client.idstringrequired

data[].client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].client.external_originstring or nullrequired

If originated from external system origin is added

data[].client.namestringrequired

data[].client.shortcodestring or nullrequired

data[].client.primary_contactUserData (object) or nullrequired

Any of:

data[].client.primary_contact.idstringrequired

data[].client.primary_contact.first_namestringrequired

data[].client.primary_contact.last_namestringrequired

data[].client.primary_contact.emailstringrequired

data[].client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].client.primary_contact.spaceobject(SpaceData)required

data[].client.primary_contact.space.idstringrequired

data[].client.primary_contact.space.namestringrequired

data[].client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].client.origin_space.idstringrequired

data[].client.origin_space.namestringrequired

data[].projectProjectData (object) or nullrequired

Any of:

data[].project.idstringrequired

data[].project.external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

data[].project.external_originstring or nullrequired

If originated from external system origin is added

data[].project.titlestringrequired

data[].project.shortcodestringrequired

data[].project.po_numberstring or nullrequired

data[].project.project_typeobject(ProjectTypeData)required

data[].project.project_type.idstringrequired

data[].project.project_type.titlestringrequired

data[].project.project_type.shortcodestringrequired

data[].project.project_type.colorstringrequired

data[].project.project_type.orderintegerrequired

data[].project.project_type.is_defaultbooleanrequired

data[].project.statusstringrequired

data[].project.is_acquisitionbooleanrequired

data[].project.is_privatebooleanrequired

data[].project.start_datestring or null(date)required

data[].project.end_datestring or null(date)required

data[].project.clientobject(ClientData)required

data[].project.client.idstringrequired

data[].project.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].project.client.external_originstring or nullrequired

If originated from external system origin is added

data[].project.client.namestringrequired

data[].project.client.shortcodestring or nullrequired

data[].project.client.primary_contactUserData (object) or nullrequired

Any of:

data[].project.client.primary_contact.idstringrequired

data[].project.client.primary_contact.first_namestringrequired

data[].project.client.primary_contact.last_namestringrequired

data[].project.client.primary_contact.emailstringrequired

data[].project.client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].project.client.primary_contact.spaceobject(SpaceData)required

data[].project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].project.client.origin_space.idstringrequired

data[].project.client.origin_space.namestringrequired

data[].project.tagsArray of objects(ProjectTagData)

data[].project.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].project.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the project is shared from, if null project is not shared

data[].project.origin_space.idstringrequired

data[].project.origin_space.namestringrequired

data[].project.teamArray of objects(TeamMemberData)

Project team

data[].project.guestsArray of objects(TeamMemberData)

Project guests

data[].project.computed_fieldsobject

data[].taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

data[].sum_netnumberrequired

data[].sum_taxnumberrequired

data[].sum_grossnumberrequired

data[].sum_external_costsnumberrequired

data[].payment_discountnumber or nullrequired

Factor in percentage

data[].discountsArray of objects(DiscountData)required

data[].discounts[].idstringrequired

data[].discounts[].titlestringrequired

data[].discounts[].discount_factornumber or nullrequired

Discount in percent

data[].discounts[].discount_absolutenumber or nullrequired

Is not calculated with invoices partial_factor in mind

data[].discounts[].from_parentbooleanrequired

If true, the discount was set in invoice master

data[].discounts[].is_payment_discountbooleanrequired

If true this discount was granted due to payment discount rules

data[].discounts[].orderintegerrequired

The order how discounts are applied

data[].line_itemsArray of objects(OutgoingInvoiceLineItemData)required

data[].line_items[].idstringrequired

data[].line_items[].titlestringrequired

data[].line_items[].typestring(AccountingLineItemType)required

Enum"unit""category""page_break"

data[].line_items[].indentintegerrequired

data[].line_items[].orderintegerrequired

data[].line_items[].pricenumberrequired

Is always the full price of the unit (without partial_factor) See partial_factor if element is part of an partial invoice

data[].line_items[].amountnumberrequired

data[].line_items[].total_net_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_net_without_discountnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_netnumberrequired

Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

data[].line_items[].total_gross_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_gross_without_discountnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

data[].line_items[].total_grossnumberrequired

Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice

data[].line_items[].tax_factornumberrequired

data[].line_items[].metricobject(MetricData)required

data[].line_items[].metric.idstringrequired

data[].line_items[].metric.titlestringrequired

data[].line_items[].metric.title_pluralstringrequired

data[].line_items[].projectProjectData (object) or nullrequired

Any of:

data[].line_items[].project.idstringrequired

data[].line_items[].project.external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

data[].line_items[].project.external_originstring or nullrequired

If originated from external system origin is added

data[].line_items[].project.titlestringrequired

data[].line_items[].project.shortcodestringrequired

data[].line_items[].project.po_numberstring or nullrequired

data[].line_items[].project.project_typeobject(ProjectTypeData)required

data[].line_items[].project.project_type.idstringrequired

data[].line_items[].project.project_type.titlestringrequired

data[].line_items[].project.project_type.shortcodestringrequired

data[].line_items[].project.project_type.colorstringrequired

data[].line_items[].project.project_type.orderintegerrequired

data[].line_items[].project.project_type.is_defaultbooleanrequired

data[].line_items[].project.statusstringrequired

data[].line_items[].project.is_acquisitionbooleanrequired

data[].line_items[].project.is_privatebooleanrequired

data[].line_items[].project.start_datestring or null(date)required

data[].line_items[].project.end_datestring or null(date)required

data[].line_items[].project.clientobject(ClientData)required

data[].line_items[].project.client.idstringrequired

data[].line_items[].project.client.external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].line_items[].project.client.external_originstring or nullrequired

If originated from external system origin is added

data[].line_items[].project.client.namestringrequired

data[].line_items[].project.client.shortcodestring or nullrequired

data[].line_items[].project.client.primary_contactUserData (object) or nullrequired

Any of:

data[].line_items[].project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the client is shared from, if null client is not shared

data[].line_items[].project.tagsArray of objects(ProjectTagData)

data[].line_items[].project.custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].line_items[].project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].line_items[].project.origin_spaceSpaceData (object) or nullrequired

Any of:

Shared space which the project is shared from, if null project is not shared

data[].line_items[].project.origin_space.idstringrequired

data[].line_items[].project.origin_space.namestringrequired

data[].line_items[].project.teamArray of objects(TeamMemberData)

Project team

data[].line_items[].project.guestsArray of objects(TeamMemberData)

Project guests

data[].line_items[].project.computed_fieldsobject

data[].line_items[].partial_factorinteger or nullrequired

Value in percent. Describes the part of the unit that is included in the invoice

data[].line_items[].exclude_from_discountbooleanrequired

If true, the unit will be excluded from offer-wide discounts

Default false

data[].line_items[].discount_factornumber or nullrequired

data[].line_items[].discount_absolutenumber or nullrequired

data[].line_items[].discount_boundbooleanrequired

If true, the amount will multiply discount absolute

Default false

data[].line_items[].purchase_pricenumberrequired

Default 0

data[].line_items[].purchase_amountnumberrequired

Default 1

data[].line_items[].purchase_total_basenumberrequired

Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice

Default 0

data[].line_items[].purchase_totalnumberrequired

Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice

Default 0

data[].line_items[].purchase_price_boundbooleanrequired

If true, purchase_amount will be in sync with amount

Default false

data[].line_items[].descriptionstringrequired

data[].line_items[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

data[].line_items[].payment_partial_intervalinteger or nullrequired

Interval if payment partial type is monthly or `yearly

Type	Interval	Description
`once`	`any`	Once per offer
`monthly`	`1`	Every month in performance range
`monthly`	`3`	Every 3 months in performance range
`monthly`	`6`	Every 6 monthsin performance range
`yearly`	`1`	Every year in performance range
`yearly`	`3`	Every 3 years in performance range
`yearly`	`6`	Every 6 years in performance range