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 |
Can be used to add an identifier to the client from an external system, must be unique
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
The key is the field name for your custom field, value type depends on the field type
Can be used to add an identifier to the client from an external system, must be unique
Can be used to add an identifier to the project from an external system, must be unique
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
The key is the field name for your custom field, value type depends on the field type
Is not calculated with invoices partial_factor in mind
If true this discount was granted due to payment discount rules
Is always the full price of the unit (without partial_factor) See partial_factor if element is part of an partial invoice
Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice
Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice
Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice
Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice
Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice
Including unit discount (not invoice discounts) and partial_factor
See partial_factor if element is part of an partial invoice
Can be used to add an identifier to the project from an external system, must be unique
If originated from external system origin is added
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
The key is the field name for your custom field, value type depends on the field type
Value in percent. Describes the part of the unit that is included in the invoice
If true, the unit will be excluded from offer-wide discounts
If true, the amount will multiply discount absolute
Excluding partial_factor and all discounts
See partial_factor if element is part of an partial invoice
Including partial_factor, excluding all discounts
See partial_factor if element is part of an partial invoice
If true, purchase_amount will be in sync with amount
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 |
For partial invoices external costs will be empty - these are part of the invoice master plan
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
Can be used to add an identifier to the project from an external system, must be unique
If originated from external system origin is added
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
The key is the field name for your custom field, value type depends on the field type
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 |
{ "id": "string", "title": "string", "type": "once", "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, "payment_discount": 0, "discounts": [ { … } ], "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 } }