Overriding Template Defaults

To override template defaults when creating an agreement, custom values can be passed into the agreement body based on the type of agreement being sent out.

Example: Overriding CSA Orderform Terms

Code
 
curl -X POST "https://api.commonpaper.com/v1/agreements" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "TEMPLATE_ID",
    "owner_email": "OWNER_EMAIL",
    "signer_email": "SIGNER_EMAIL",
    "agreement": {
      "recipient_name": "Recipient Name",
      "recipient_email": "RECIPIENT_EMAIL",
      "recipient_organization_name": "RECIPIENT_ORG",
      "message": "This is the agreement we spoke about.",
      "test_agreement": false,
      "csa_order_form_attributes": {
        "fees_attributes": {
          "0": {
            "description": "Description of a flat fee",
            "type": "Fees::Flat",
            "cost": 10000
          }
        }
      }
    }
  }'

This would add an extra fee on-top of any fees currently applied to the template.

Code
 
{
  "csa_order_form_attributes": {
    "fees_attributes": {
      "0": {
        "description": "Flat fee",
        "type": "Flat::Fee",
        "cost": 50
      },
      "1": {
        "description": "Fees discount",
        "type": "Fees::Discount",
        "cost": 100,
        "discount_type": "fixed_amount",
        "discount_duration_type": "forever"
      },
      "2": {
        "description": "Fees attachment",
        "type": "Fees::Attachment",
        "attachment_id": "ID"
      }
    }
  }
}

Fee types

• Fees::Flat
• Fees::Discount
• Fees::Cost
• Fees::Attachment
• Fees::Graduated
• Fees::Included
• Fees::Metered
• Fees::OneTime
• Fees::Text

Agreement Specific Keys

• csa_attributes
• csa_order_form_attributes
• dpa_attributes
• design_partner_attributes
• psa_attributes
• psa_statement_of_work_attributes
• partnership_attributes
• partnership_business_terms_attributes
• baa_attributes
• loi_attributes

If the template type does not correspond to the overridden attribute type, the agreement creation will fail.

To retrieve fields specific to an agreement type you can:

• Export a CSV (requires paid plan)
• Create an agreement and examine the response
• Call the show endpoint of the API and look at agreement columns that exist on existing agreements