Fully update template

Fully updates a template, by ID. In the JSON request body, include a complete template object. This call does not support partial updates.

PUT /v2/invoicing/templates/{template_id}

Fully update template

cURL

curl --request PUT \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/templates/{template_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "default_template": true,
  "template_info": {
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "extension_number": "<string>"
        }
      ],
      "website": "<string>",
      "tax_id": "<string>",
      "additional_notes": "<string>",
      "logo_url": "<string>"
    },
    "primary_recipients": [
      {
        "billing_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "extension_number": "<string>"
            }
          ],
          "additional_info": "<string>",
          "language": "<string>"
        },
        "shipping_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "name": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "description": "<string>",
        "item_date": "<string>",
        "discount": {
          "percent": "<string>"
        }
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "discount": {
          "invoice_discount": {
            "percent": "<string>"
          }
        },
        "shipping": {}
      }
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "display_preference": {
          "hidden": false
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "display_preference": {
          "hidden": false
        }
      }
    ]
  }
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "default_template": true,
  "template_info": {
    "detail": {
      "currency_code": "<string>",
      "reference": "<string>",
      "note": "<string>",
      "terms_and_conditions": "<string>",
      "memo": "<string>",
      "attachments": [
        {
          "id": "<string>",
          "reference_url": "<string>",
          "content_type": "<string>",
          "create_time": "<string>",
          "size": "<string>"
        }
      ],
      "payment_term": {},
      "metadata": {
        "create_time": "<string>",
        "created_by": "<string>",
        "last_update_time": "<string>",
        "last_updated_by": "<string>"
      }
    },
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "address": {
        "country_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "admin_area_4": "<string>",
        "admin_area_3": "<string>",
        "admin_area_2": "<string>",
        "admin_area_1": "<string>",
        "postal_code": "<string>",
        "address_details": {
          "street_number": "<string>",
          "street_name": "<string>",
          "street_type": "<string>",
          "delivery_service": "<string>",
          "building_name": "<string>",
          "sub_building": "<string>"
        }
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "extension_number": "<string>"
        }
      ],
      "website": "<string>",
      "tax_id": "<string>",
      "additional_notes": "<string>",
      "logo_url": "<string>"
    },
    "primary_recipients": [
      {
        "billing_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "address": {
            "country_code": "<string>",
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "address_details": {
              "street_number": "<string>",
              "street_name": "<string>",
              "street_type": "<string>",
              "delivery_service": "<string>",
              "building_name": "<string>",
              "sub_building": "<string>"
            }
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "extension_number": "<string>"
            }
          ],
          "additional_info": "<string>",
          "language": "<string>"
        },
        "shipping_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "address": {
            "country_code": "<string>",
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "address_details": {
              "street_number": "<string>",
              "street_name": "<string>",
              "street_type": "<string>",
              "delivery_service": "<string>",
              "building_name": "<string>",
              "sub_building": "<string>"
            }
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "name": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "id": "<string>",
        "description": "<string>",
        "tax": {
          "name": "<string>",
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax_note": "<string>"
        },
        "item_date": "<string>",
        "discount": {
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        }
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false,
        "minimum_amount_due": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "item_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "discount": {
          "invoice_discount": {
            "percent": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            }
          },
          "item_discount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "tax_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping": {
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax": {
            "name": "<string>",
            "percent": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "tax_note": "<string>"
          }
        },
        "custom": {
          "label": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        }
      }
    },
    "due_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "display_preference": {
          "hidden": false
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "display_preference": {
          "hidden": false
        }
      }
    ]
  },
  "standard_template": true,
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "issue": "TEMPLATE_NAME_ALREADY_EXISTS",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "Template name already exists."
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "details": [
    {
      "issue": "PERMISSION_DENIED",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "The requested invoice is not associated with the requested user."
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "details": [
    {
      "issue": "<string>",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "<string>"
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "issue": "<string>",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "<string>"
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Path Parameters

template_id · string · required

The ID of the template to delete.

Maximum string length: 2147483647

Pattern: ^.*$

Body

application/json

A representation of changes to make in the template.

The template with invoice details to load with all captured fields.

name · string

The template name.

Note: The template name must be unique.

Required string length: 1 - 500

Pattern: ^[\S\s]*$

default_template · boolean

Indicates whether this template is the default template. A invoicer can have one default template.

template_info · Template Information · object

The template details. Includes invoicer business information, invoice recipients, items, and configuration.

Show child attributes

settings · Template Settings · object

The template settings. Describes which fields to show or hide when you create an invoice.

Show child attributes

unit_of_measure · enum<string>

The unit of measure for the template. Value is quantity, hours, or amount.

Available options: QUANTITY, HOURS, AMOUNT

Maximum string length: 2147483647

Pattern: ^[\S\s]*$

Response

200

application/json

A successful request returns the HTTP 200 OK status code. A JSON response body that shows template details is returned if you set prefer=return=representation.

The template with invoice details to load with all captured fields.

id · string · read-only

The ID of the template.

Maximum string length: 30

Pattern: ^[\S\s]*$

name · string

The template name.

Note: The template name must be unique.

Required string length: 1 - 500

Pattern: ^[\S\s]*$

default_template · boolean

Indicates whether this template is the default template. A invoicer can have one default template.

template_info · Template Information · object

The template details. Includes invoicer business information, invoice recipients, items, and configuration.

Show child attributes

settings · Template Settings · object

The template settings. Describes which fields to show or hide when you create an invoice.

Show child attributes

unit_of_measure · enum<string>

The unit of measure for the template. Value is quantity, hours, or amount.

Available options: QUANTITY, HOURS, AMOUNT

Maximum string length: 2147483647

Pattern: ^[\S\s]*$

standard_template · boolean · read-only

Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Maximum array length: 2147483647

Show child attributes