Offer

• Allowed query parameters
• Create an offer
• Update an offer
• Retrieve an offer
• Delete an offer
• List offers
• Offer line items
• Add products to an offer
• Send an offer

Allowed query parameters

Filters

Filter	Type	Description
search	String	Full-text search
project	Id	Filter by Project Id
company	String	Filter by Company Id
status	String	Filter based on status: approved, rejected, pending, draft, approved_or_pending, billable
member	Id	Filter by Member Id
custom_field	Key,String	Filter by Custom Field (eg. my_internal_id,42)
trashed	Boolean	Include soft-deleted offers

Sorting

name, created_at, approved_at

Includes

project, project.offers, contact.company.media, company.media, elements.tag, elements.product, member.user.media, createdBy.user.media, updatedBy.user.media, activities, sourcedInvoices, comments.commentator.media, media

Create an offer

post

/offer

Attribute (* required)	Type	Description
name	String?	Offer title (max 255 characters)
project_id	String?	A Project Id (min 10 characters)
contact_id *	String	A Contact Id (min 10 characters)
locked_at	Date?	Locked date
approved_at	Date?	Approved date
address	String?	Recipient Address
header	String?	Header text
footer	String?	Footer text
has_page_break_after_header	Boolean	Add page break after header
has_page_break_before_footer	Boolean	Add page break before footer
description	String?	Offer description
custom_fields	Object?	Custom data as Custom Fields

Example response

// HTTP 201 Created
{
    // an offer object
}

Update an offer

put

/offer/{id}

Attribute (* required)	Type	Description
name	String?	Offer title (max 255 characters)
project_id	String?	A Project Id (min 10 characters)
contact_id	String	A Contact Id (min 10 characters)
locked_at	Date?	Locked date
approved_at	Date?	Approved date
address	String	Recipient Address
header	String?	Header text
footer	String?	Footer text
has_page_break_after_header	Boolean	Add page break after header
has_page_break_before_footer	Boolean	Add page break before footer
description	String?	Offer description
custom_fields	Object?	Custom data as Custom Fields

Example response

// HTTP 200 OK
{
    // an offer object
}

Retrieve an offer

get

/offer/{id}

Example response

// HTTP 200 OK
{
    "id": "EO6YGvqMRV",
    "number": "A-01025",
    "name": "CMS Upgrade",
    "description": null,
    "address": "<p><strong>StrawBlond</strong><br> Alice Cooper<br>R\u00fctistrasse 2<br>CH-8645 Rapperswil</p>",
    "header": "<p>Sehr geehrte Damen und Herren</p><p>Vielen Dank f\u00fcr Ihr Interesse</p>",
    "footer": "<p>Vielen Dank f\u00fcr eine fristgerechte Zahlung.</p><p>Freundliche Gr\u00fcsse<br>StrawBlond GmbH</p>",
    "has_page_break_after_header": false,
    "has_page_break_before_footer": false,
    "approved_at": "2022-02-09T08:51:59.000000Z",
    "rejected_at": null,
    "locked_at": "2022-02-09T08:51:59.000000Z",
    "is_approved": true,
    "is_rejected": false,
    "is_locked": true,
    "address_personalized": "<p><strong>StrawBlond</strong><br> Alice Cooper<br>Rütistrasse 2<br>CH-8645 Rapperswil</p>",
    "header_personalized": "<p>Sehr geehrte Damen und Herren</p><p>Vielen Dank für Ihr Interesse</p>",
    "footer_personalized": "<p>Vielen Dank für eine fristgerechte Zahlung.</p><p>Freundliche Grüsse<br>StrawBlond GmbH</p>",
    "project": {
        // Project object when included
    },
    "contact": {
        // Contact object when included
    },
    "member": {
        // Member object when included
    },
    "created_by": {
        // Member object when included
    },
    "updated_by": {
        // Member object when included
    },
    "company": {
        // Company object when included
    },
    "elements": [
        // Only present when included `elements` relation
        {
            // a document element object
        }
    ],
    "total": 5640.0,
    "total_with_vat": 5640.0,
    "total_optional": 0.0,
    "show_vat": true,
    "vat_detailed": {
        "0.0": {
            "rate": 0.0,
            "net": 5640.0,
            "tax": 0.0
        }
    },
    "pdf_url": "http://localhost:8000/api/offer/EO6YGvqMRV/pdf?expires=1666341757&signature=331e3d4442bb23f4f9803fa56d27f581127836c240fd5b46917b7a33769f6c60",
    "order_confirmation_pdf_url": "http://localhost:8000/api/offer/EO6YGvqMRV/pdf?expires=1666341757&options%5Border_confirmation%5D=1&signature=abc123",
    "preview_url": "http://localhost:8000/api/offer/339/view?signature=686f2f15cda2a5d95657e463ac550aba7be9465ad80cca2787da11c8e04244e7",
    "approve_url": "http://localhost:8000/api/offer/EO6YGvqMRV/approve?expires=1666341757&signature=cb1b209e99bad2a7c18cc6b48d0f2123ad4cc3f6a47e0309b21be074218c58f9",
    "reject_url": "http://localhost:8000/api/offer/EO6YGvqMRV/reject?expires=1666341757&signature=67280f02330d155611a9694f73726df64628c7c13b5f34f369abbf89ed5fddc1",
    "share_url": "http://localhost:3000/offer/feedback/?lang=de&api=http%3A%2F%2Flocalhost%3A8000%2Fapi%2Foffer%2FEO6YGvqMRV%2Ffeedback%3Fexpires%3D1664959357%26signature%3D91ddff48f1d85dedd8c932badf736c319fffb976e30ef44034dba3c9d609fdb9",
    "mail_preview_url": "https://api.strawblond.com/api/document/mail-preview?type=offer&id=EO6YGvqMRV",
    "show_terms": true,
    "show_signature": false,
    "activities": [
        // Only present when included `activities` relation
    ],
    "sourced_invoices": [
        // Only present when included `sourcedInvoices` relation
    ],
    "billable_total": 5640.0,
    "billed_total": 0.0,
    "organization": {
        // Organization object when included
    },
    "comments": [
        // Only present when included `comments` relation
    ],
    "attachments": [
        // Only present when included `media` relation
    ],
    "custom_fields": {},
    "updated_at": "2022-02-09T08:52:00.000000Z",
    "created_at": "2021-12-09T09:05:28.000000Z",
    "deleted_at": null
}

Delete an offer

delete

/offer/{id}

Example response

// HTTP 204 No Content

List offers

get

/offer

The list endpoint accepts the same parameters as in Retrieve an offer and returns a paginated array of the same offer object in the data property.

Read more about Pagination, Filtering, Sorting and Includes on the Introduction page.

Offer line items

You may use the Document Element endpoint to create, update or delete line items on an offer.

Add products to an offer

post

/offer/{id}/add-products

Attribute (* required)	Type	Description
products *	Array	Array of Product IDs to add to the offer
beforeOrder	Number?	Order position to insert products before (if not provided, adds to the end)

Example request

{
    "products": ["6k2KpJY3By", "8m3LqKZ4Cx"],
    "beforeOrder": 2
}

Example response

// HTTP 200 OK
{
    // an offer object
}

Send an offer

post

/offer/{id}/send

Attribute (* required)	Type	Description
email	String	List of emails (separated by ";", Default: Contact email)
message	String?	A short message to the recipients
ccToOwner	Boolean	Send a carbon copy to self
attachments	Array	Array of media UUIDs to attach to the offer

Example response

// HTTP 200 OK
{
    // an offer object
}