Available sorts are offer_number, title, date_of_offer, 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
`offer_number`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`date_of_offer`	`date`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`date_of_expiry`	`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_gross (currency) - total_gross_base (currency) - purchase_total (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/offers?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 OfferData

Bodyapplication/json

dataArray of objects(OfferData)required

The list of items

data[].idstringrequired

data[].offer_numberstring or nullrequired

data[].titlestringrequired

data[].statusstring(OfferStatus)required


`open` Offer in draft
`approval_pending` Offer was submitted for internal approval
`approval_approved` Offer was internally approved
`transformed` Customer approved offer
`cancelled` Customer declined offer

Enum"open""approval_pending""approval_approved""transformed""cancelled"

data[].approvals_neededinteger or nullrequired

data[].is_direct_approvedboolean or nullrequired

Offer skipped internal approval process - can also be true if offer is still open, due to reopening

data[].date_of_offerstring(date-time)required

data[].date_of_expirystring(date-time)required

data[].performance_range_startstring(date-time)required

data[].performance_range_endstring(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[].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[].line_itemsArray of objects(OfferLineItemData)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[].is_optionalbooleanrequired

data[].line_items[].pricenumberrequired

data[].line_items[].amountnumberrequired

data[].line_items[].total_net_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

data[].line_items[].total_netnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

data[].line_items[].total_gross_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

data[].line_items[].tax_factornumberrequired

data[].line_items[].total_grossnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

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[].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_totalnumberrequired

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

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"
  }
}

Retrieve an offer

Request

Required scopes: offer:read

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

curl -i -X GET \
  'https://api.kanbert.com/api/v1/offers/{id}?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OfferData

Bodyapplication/json

idstringrequired

offer_numberstring or nullrequired

titlestringrequired

statusstring(OfferStatus)required


`open` Offer in draft
`approval_pending` Offer was submitted for internal approval
`approval_approved` Offer was internally approved
`transformed` Customer approved offer
`cancelled` Customer declined offer

Enum"open""approval_pending""approval_approved""transformed""cancelled"

approvals_neededinteger or nullrequired

is_direct_approvedboolean or nullrequired

Offer skipped internal approval process - can also be true if offer is still open, due to reopening

date_of_offerstring(date-time)required

date_of_expirystring(date-time)required

performance_range_startstring(date-time)required

performance_range_endstring(date-time)required

localestringrequired

currencystringrequired

addressstringrequired

address_changedbooleanrequired

If true the user manually overwrote the companies address

companyCompanyData (object) or nullrequired

Any of:

company.idstringrequired

company.external_idstring or nullrequired

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

company.external_originstring or nullrequired

If originated from external system origin is added

company.vendor_identifierstring or nullrequired

company.company_namestring or nullrequired

company.localestring or nullrequired

company.tax_uidstring or nullrequired

company.taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

company.ibanstring or nullrequired

company.bicstring or nullrequired

company.emailstring or nullrequired

company.email_generalstring or nullrequired

company.phonestring or nullrequired

company.faxstring or nullrequired

company.homepagestring or nullrequired

company.invoices_by_postbooleanrequired

Default false

company.invoices_by_emailbooleanrequired

Default false

company.business_fieldBusinessFieldData (object) or nullrequired

Any of:

company.business_field.idstringrequired

company.business_field.namestringrequired

company.company_sizeTagData (object) or nullrequired

Any of:

company.company_size.idstringrequired

company.company_size.titlestringrequired

company.company_revenueTagData (object) or nullrequired

Any of:

company.company_revenue.idstringrequired

company.company_revenue.titlestringrequired

company.person_attention_tostring or nullrequired

company.address_invoice_titlestring or nullrequired

company.address_invoice_streetstring or nullrequired

company.address_invoice_housestring or nullrequired

company.address_invoice_street2string or nullrequired

company.address_invoice_zipstring or nullrequired

company.address_invoice_statestring or nullrequired

company.address_invoice_townstring or nullrequired

company.address_invoice_countryCountryData (object) or nullrequired

Any of:

company.address_invoice_country.idstringrequired

company.address_invoice_country.namestringrequired

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

company.address_invoice_is_deliverybooleanrequired

company.delivery_person_attention_tostring or nullrequired

company.address_delivery_titlestring or nullrequired

company.address_delivery_streetstring or nullrequired

company.address_delivery_housestring or nullrequired

company.address_delivery_street2string or nullrequired

company.address_delivery_zipstring or nullrequired

company.address_delivery_statestring or nullrequired

company.address_delivery_townstring or nullrequired

company.address_delivery_countryCountryData (object) or nullrequired

Any of:

company.address_delivery_country.idstringrequired

company.address_delivery_country.namestringrequired

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

company.clientClientData (object) or nullrequired

Any of:

company.client.idstringrequired

company.client.external_idstring or nullrequired

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

company.client.external_originstring or nullrequired

If originated from external system origin is added

company.client.namestringrequired

company.client.shortcodestring or nullrequired

company.client.primary_contactUserData (object) or nullrequired

Any of:

company.client.primary_contact.idstringrequired

company.client.primary_contact.first_namestringrequired

company.client.primary_contact.last_namestringrequired

company.client.primary_contact.emailstringrequired

company.client.primary_contact.typestring(UserType)required

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

company.client.primary_contact.spaceobject(SpaceData)required

company.client.primary_contact.space.idstringrequired

company.client.primary_contact.space.namestringrequired

company.client.origin_spaceSpaceData (object) or nullrequired

Any of:

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

company.client.origin_space.idstringrequired

company.client.origin_space.namestringrequired

company.tagsArray of objects(TagData)

company.contactsArray of objects(ContactData)

company.custom_fieldsobjectrequired

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

company.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

company.created_atstring(date-time)required

company.updated_atstring or null(date-time)required

company.deleted_atstring or null(date-time)required

company.contact_companyobject(ContactCompanyPivotData)

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

editorUserData (object) or nullrequired

Any of:

editor.idstringrequired

editor.first_namestringrequired

editor.last_namestringrequired

editor.emailstringrequired

editor.typestring(UserType)required

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

editor.spaceobject(SpaceData)required

editor.space.idstringrequired

editor.space.namestringrequired

clientobject(ClientData)required

client.idstringrequired

client.external_idstring or nullrequired

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

client.external_originstring or nullrequired

If originated from external system origin is added

client.namestringrequired

client.shortcodestring or nullrequired

client.primary_contactUserData (object) or nullrequired

Any of:

client.primary_contact.idstringrequired

client.primary_contact.first_namestringrequired

client.primary_contact.last_namestringrequired

client.primary_contact.emailstringrequired

client.primary_contact.typestring(UserType)required

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

client.primary_contact.spaceobject(SpaceData)required

client.primary_contact.space.idstringrequired

client.primary_contact.space.namestringrequired

client.origin_spaceSpaceData (object) or nullrequired

Any of:

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

client.origin_space.idstringrequired

client.origin_space.namestringrequired

projectProjectData (object) or nullrequired

Any of:

project.idstringrequired

project.external_idstring or nullrequired

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

project.external_originstring or nullrequired

If originated from external system origin is added

project.titlestringrequired

project.shortcodestringrequired

project.po_numberstring or nullrequired

project.project_typeobject(ProjectTypeData)required

project.project_type.idstringrequired

project.project_type.titlestringrequired

project.project_type.shortcodestringrequired

project.project_type.colorstringrequired

project.project_type.orderintegerrequired

project.project_type.is_defaultbooleanrequired

project.statusstringrequired

project.is_acquisitionbooleanrequired

project.is_privatebooleanrequired

project.start_datestring or null(date)required

project.end_datestring or null(date)required

project.clientobject(ClientData)required

project.client.idstringrequired

project.client.external_idstring or nullrequired

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

project.client.external_originstring or nullrequired

If originated from external system origin is added

project.client.namestringrequired

project.client.shortcodestring or nullrequired

project.client.primary_contactUserData (object) or nullrequired

Any of:

project.client.primary_contact.idstringrequired

project.client.primary_contact.first_namestringrequired

project.client.primary_contact.last_namestringrequired

project.client.primary_contact.emailstringrequired

project.client.primary_contact.typestring(UserType)required

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

project.client.primary_contact.spaceobject(SpaceData)required

project.client.primary_contact.space.idstringrequired

project.client.primary_contact.space.namestringrequired

project.client.origin_spaceSpaceData (object) or nullrequired

Any of:

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

project.client.origin_space.idstringrequired

project.client.origin_space.namestringrequired

project.tagsArray of objects(ProjectTagData)

project.custom_fieldsobjectrequired

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

project.custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

project.origin_spaceSpaceData (object) or nullrequired

Any of:

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

project.origin_space.idstringrequired

project.origin_space.namestringrequired

project.teamArray of objects(TeamMemberData)

Project team

project.guestsArray of objects(TeamMemberData)

Project guests

project.computed_fieldsobject

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

sum_netnumberrequired

sum_taxnumberrequired

sum_grossnumberrequired

sum_external_costsnumberrequired

line_itemsArray of objects(OfferLineItemData)required

line_items[].idstringrequired

line_items[].titlestringrequired

line_items[].typestring(AccountingLineItemType)required

Enum"unit""category""page_break"

line_items[].indentintegerrequired

line_items[].orderintegerrequired

line_items[].is_optionalbooleanrequired

line_items[].pricenumberrequired

line_items[].amountnumberrequired

line_items[].total_net_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

line_items[].total_netnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

line_items[].total_gross_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

line_items[].tax_factornumberrequired

line_items[].total_grossnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

line_items[].metricobject(MetricData)required

line_items[].metric.idstringrequired

line_items[].metric.titlestringrequired

line_items[].metric.title_pluralstringrequired

line_items[].projectProjectData (object) or nullrequired

Any of:

line_items[].project.idstringrequired

line_items[].project.external_idstring or nullrequired

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

line_items[].project.external_originstring or nullrequired

If originated from external system origin is added

line_items[].project.titlestringrequired

line_items[].project.shortcodestringrequired

line_items[].project.po_numberstring or nullrequired

line_items[].project.project_typeobject(ProjectTypeData)required

line_items[].project.project_type.idstringrequired

line_items[].project.project_type.titlestringrequired

line_items[].project.project_type.shortcodestringrequired

line_items[].project.project_type.colorstringrequired

line_items[].project.project_type.orderintegerrequired

line_items[].project.project_type.is_defaultbooleanrequired

line_items[].project.statusstringrequired

line_items[].project.is_acquisitionbooleanrequired

line_items[].project.is_privatebooleanrequired

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

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

line_items[].project.clientobject(ClientData)required

line_items[].project.client.idstringrequired

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

line_items[].project.client.external_originstring or nullrequired

If originated from external system origin is added

line_items[].project.client.namestringrequired

line_items[].project.client.shortcodestring or nullrequired

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

Any of:

line_items[].project.client.primary_contact.idstringrequired

line_items[].project.client.primary_contact.first_namestringrequired

line_items[].project.client.primary_contact.last_namestringrequired

line_items[].project.client.primary_contact.emailstringrequired

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

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

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

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

line_items[].project.client.origin_space.idstringrequired

line_items[].project.client.origin_space.namestringrequired

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

line_items[].project.custom_fieldsobjectrequired

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

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

Any of:

string

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

Any of:

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

line_items[].project.origin_space.idstringrequired

line_items[].project.origin_space.namestringrequired

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

Project team

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

Project guests

line_items[].project.computed_fieldsobject

line_items[].exclude_from_discountbooleanrequired

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

Default false

line_items[].discount_factornumber or nullrequired

line_items[].discount_absolutenumber or nullrequired

line_items[].discount_boundbooleanrequired

If true, the amount will multiply discount absolute

Default false

line_items[].purchase_pricenumberrequired

Default 0

line_items[].purchase_amountnumberrequired

Default 1

line_items[].purchase_totalnumberrequired

Default 0

line_items[].purchase_price_boundbooleanrequired

If true, purchase_amount will be in sync with amount

Default false

line_items[].descriptionstringrequired

line_items[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

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

external_costsArray of objects(ExternalCostData)required

external_costs[].idstringrequired

external_costs[].titlestringrequired

external_costs[].typestringrequired

external_costs[].indentintegerrequired

external_costs[].orderintegerrequired

external_costs[].is_creditbooleanrequired

if true this cost is a credit

external_costs[].is_optionalbooleanrequired

external_costs[].pricenumberrequired

external_costs[].amountnumberrequired

external_costs[].totalnumberrequired

external_costs[].supplierSupplierData (object) or nullrequired

Any of:

external_costs[].supplier.idstringrequired

external_costs[].supplier.namestringrequired

external_costs[].clientClientData (object) or nullrequired

Any of:

external_costs[].client.idstringrequired

external_costs[].client.external_idstring or nullrequired

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

external_costs[].client.external_originstring or nullrequired

If originated from external system origin is added

external_costs[].client.namestringrequired

external_costs[].client.shortcodestring or nullrequired

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

Any of:

external_costs[].client.primary_contact.idstringrequired

external_costs[].client.primary_contact.first_namestringrequired

external_costs[].client.primary_contact.last_namestringrequired

external_costs[].client.primary_contact.emailstringrequired

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

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

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

external_costs[].client.primary_contact.space.idstringrequired

external_costs[].client.primary_contact.space.namestringrequired

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

Any of:

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

external_costs[].client.origin_space.idstringrequired

external_costs[].client.origin_space.namestringrequired

external_costs[].projectProjectData (object) or nullrequired

Any of:

external_costs[].project.idstringrequired

external_costs[].project.external_idstring or nullrequired

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

external_costs[].project.external_originstring or nullrequired

If originated from external system origin is added

external_costs[].project.titlestringrequired

external_costs[].project.shortcodestringrequired

external_costs[].project.po_numberstring or nullrequired

external_costs[].project.project_typeobject(ProjectTypeData)required

external_costs[].project.project_type.idstringrequired

external_costs[].project.project_type.titlestringrequired

external_costs[].project.project_type.shortcodestringrequired

external_costs[].project.project_type.colorstringrequired

external_costs[].project.project_type.orderintegerrequired

external_costs[].project.project_type.is_defaultbooleanrequired

external_costs[].project.statusstringrequired

external_costs[].project.is_acquisitionbooleanrequired

external_costs[].project.is_privatebooleanrequired

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

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

external_costs[].project.clientobject(ClientData)required

external_costs[].project.client.idstringrequired

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

external_costs[].project.client.external_originstring or nullrequired

If originated from external system origin is added

external_costs[].project.client.namestringrequired

external_costs[].project.client.shortcodestring or nullrequired

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

Any of:

external_costs[].project.client.primary_contact.idstringrequired

external_costs[].project.client.primary_contact.first_namestringrequired

external_costs[].project.client.primary_contact.last_namestringrequired

external_costs[].project.client.primary_contact.emailstringrequired

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

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

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

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

external_costs[].project.client.origin_space.idstringrequired

external_costs[].project.client.origin_space.namestringrequired

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

external_costs[].project.custom_fieldsobjectrequired

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

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

Any of:

string

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

Any of:

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

external_costs[].project.origin_space.idstringrequired

external_costs[].project.origin_space.namestringrequired

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

Project team

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

Project guests

external_costs[].project.computed_fieldsobject

external_costs[].statusstring or nullrequired

external_costs[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

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

external_costs[].created_atstring(date-time)required

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

created_atstring(date-time)required

updated_atstring or null(date-time)required

deleted_atstring or null(date-time)required

computed_fieldsobject

Response

application/json

{
  "id": "string",
  "offer_number": "string",
  "title": "string",
  "status": "open",
  "approvals_needed": 0,
  "is_direct_approved": true,
  "date_of_offer": "2019-08-24T14:15:22Z",
  "date_of_expiry": "2019-08-24T14:15:22Z",
  "performance_range_start": "2019-08-24T14:15:22Z",
  "performance_range_end": "2019-08-24T14:15:22Z",
  "locale": "string",
  "currency": "string",
  "address": "string",
  "address_changed": true,
  "company": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation_enabled": true,
    "iban": "string",
    "bic": "string",
    "email": "string",
    "email_general": "string",
    "phone": "string",
    "fax": "string",
    "homepage": "string",
    "invoices_by_post": false,
    "invoices_by_email": false,
    "business_field": { … },
    "company_size": { … },
    "company_revenue": { … },
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_house": "string",
    "address_invoice_street2": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_country": { … },
    "address_invoice_is_delivery": true,
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_house": "string",
    "address_delivery_street2": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": { … },
    "client": { … },
    "tags": [ … ],
    "contacts": [ … ],
    "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "contact_company": { … }
  },
  "editor": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "project": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "title": "string",
    "shortcode": "string",
    "po_number": "string",
    "project_type": { … },
    "status": "string",
    "is_acquisition": true,
    "is_private": true,
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "client": { … },
    "tags": [ … ],
    "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
    "origin_space": { … },
    "team": [ … ],
    "guests": [ … ],
    "computed_fields": { … }
  },
  "taxation_enabled": true,
  "sum_net": 0,
  "sum_tax": 0,
  "sum_gross": 0,
  "sum_external_costs": 0,
  "line_items": [
    { … }
  ],
  "external_costs": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "computed_fields": {
    "property1": 0,
    "property2": 0
  }
}

List all offer lineItems

Request

Required scopes: offer:read

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

sortstring

Available sorts are title, price, total, purchase_price, purchase_total, created_at, updated_at.
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

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
`title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`price`	`float`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`amount`	`float`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, 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
`total`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`purchase_price`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`purchase_total`	`currency`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull
`type`	`enum<AccountingLineItemType>`	eq, ne, neq, in, nin, notin
`metric.id`	`id<MetricData>`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`metric.title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull

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")

curl -i -X GET \
  'https://api.kanbert.com/api/v1/offers/{id}/line-items?find_by=id&origin=string&sort=sort%3D-created_at%2Ctitle&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' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of OfferLineItemData

Bodyapplication/json

dataArray of objects(OfferLineItemData)required

The list of items

data[].idstringrequired

data[].titlestringrequired

data[].typestring(AccountingLineItemType)required

Enum"unit""category""page_break"

data[].indentintegerrequired

data[].orderintegerrequired

data[].is_optionalbooleanrequired

data[].pricenumberrequired

data[].amountnumberrequired

data[].total_net_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

data[].total_netnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

data[].total_gross_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

data[].tax_factornumberrequired

data[].total_grossnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

data[].metricobject(MetricData)required

data[].metric.idstringrequired

data[].metric.titlestringrequired

data[].metric.title_pluralstringrequired

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[].exclude_from_discountbooleanrequired

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

Default false

data[].discount_factornumber or nullrequired

data[].discount_absolutenumber or nullrequired

data[].discount_boundbooleanrequired

If true, the amount will multiply discount absolute

Default false

data[].purchase_pricenumberrequired

Default 0

data[].purchase_amountnumberrequired

Default 1

data[].purchase_totalnumberrequired

Default 0

data[].purchase_price_boundbooleanrequired

If true, purchase_amount will be in sync with amount

Default false

data[].descriptionstringrequired

data[].payment_partial_typestring(OfferUnitIntervalType)required

Enum"once""monthly""yearly"

data[].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

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"
  }
}

Download offer PDF

Request

Required scopes: offer:read

Security

http or oauth2

Path

idstringrequired

The ID of the offer to be downloaded.

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

curl -i -X GET \
  'https://api.kanbert.com/api/v1/offers/{id}/pdf?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Headers

Content-Dispositionstringrequired

Example: "attachment"

Bodyapplication/octet-stream

string(binary)

Response

No content

Outgoing Invoices
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Payments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Usergroups & Teams
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Settings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Integration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Files
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Custom Fields
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Webhook Management
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Schemas
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Schemas

Kanbert (v1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Clients
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Projects
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Task Comments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Efforts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Contacts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Companies
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Offers
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

List all offers

Request

Responses

Was this helpful?

Retrieve an offer

Request

Responses

Was this helpful?

List all offer lineItems

Request

Responses

Was this helpful?

Download offer PDF

Request

Responses

Was this helpful?

Outgoing Invoices
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Payments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Usergroups & Teams
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Settings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Integration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Files
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Custom Fields
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Webhook Management
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Schemas
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Kanbert (v1)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ClientsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ProjectsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TasksCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Task CommentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

EffortsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ContactsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CompaniesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

OffersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

List all offers

Request

Responses

Was this helpful?

Retrieve an offer

Request

Responses

Was this helpful?

List all offer lineItems

Request

Responses

Was this helpful?

Download offer PDF

Request

Responses

Was this helpful?

Outgoing InvoicesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PaymentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Usergroups & TeamsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SettingsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

IntegrationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

FilesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Custom FieldsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Webhook ManagementCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SchemasCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Kanbert (v1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Clients
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Projects
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Task Comments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Efforts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Contacts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Companies
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Offers
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Outgoing Invoices
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Payments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Usergroups & Teams
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Settings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Integration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Files
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Custom Fields
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Webhook Management
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Schemas
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude