Qodex.ai

Create template

POST {{base_url}}/v2/invoicing/templates

Creates an invoice template. You can use details from this template to create an invoice. You can create up to 50 templates.

Note: Every merchant starts with three PayPal system templates that are optimized for the unit type billed. The template includes Quantity , Hours , and Amount .

Request Body

{"name"=>"template_{{$timestamp}}", "default_template"=>true, "template_info"=>{"configuration"=>{"tax_calculated_after_discount"=>true, "tax_inclusive"=>false, "allow_tip"=>true, "partial_payment"=>{"allow_partial_payment"=>true, "minimum_amount_due"=>{"currency_code"=>"USD", "value"=>"20.00"}}}, "detail"=>{"reference"=>"deal-ref", "note"=>"Thank you for your business.", "currency_code"=>"USD", "terms_and_conditions"=>"No refunds after 30 days.", "memo"=>"This is a long contract", "attachments"=>[{"id"=>"Screen Shot 2018-11-23 at 16.45.01.png", "reference_url"=>"https://api-m.paypal.com/invoice/payerView/attachments/RkG9ggQbd4Mwm1tYdcF6uuixfFTFq32bBdbE1VbtQLdKSoS2ZOYpfjw9gPp7eTrZmVaFaDWzixHXm-OXWHbmigHigHzURDxJs8IIKqcqP8jawnBEZcraEAPVMULxf5iTyOSpAUc2ugW0PWdwDbM6mg-guFAUyj3Z98H7htWNjQY95jb9heOlcSXUe.sbDUR9smAszzzJoA1NXT6rEEegwQ&version=1&sig=JNODB0xEayW8txMQm6ZsIwDnd4eh3hd6ijiRLi4ipHE"}], "payment_term"=>{"term_type"=>"NET_10"}}, "invoicer"=>{"name"=>{"given_name"=>"David", "surname"=>"Larusso"}, "address"=>{"address_line_1"=>"1234 First Street", "address_line_2"=>"337673 Hillside Court", "admin_area_2"=>"Anytown", "admin_area_1"=>"CA", "postal_code"=>"98765", "country_code"=>"US"}, "email_address"=>"merchant@example.com", "phones"=>[{"country_code"=>"001", "national_number"=>"4085551234", "phone_type"=>"MOBILE"}], "website"=>"www.test.com", "tax_id"=>"ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g", "logo_url"=>"https://example.com/logo.PNG", "additional_notes"=>"2-4"}, "primary_recipients"=>[{"billing_info"=>{"name"=>{"given_name"=>"Stephanie", "surname"=>"Meyers"}, "address"=>{"address_line_1"=>"1234 Main Street", "admin_area_2"=>"Anytown", "admin_area_1"=>"CA", "postal_code"=>"98765", "country_code"=>"US"}, "email_address"=>"bill-me@example.com", "phones"=>[{"country_code"=>"001", "national_number"=>"4884551234", "phone_type"=>"MOBILE"}], "additional_info"=>"add-info"}, "shipping_info"=>{"name"=>{"given_name"=>"Stephanie", "surname"=>"Meyers"}, "address"=>{"address_line_1"=>"1234 Main Street", "admin_area_2"=>"Anytown", "admin_area_1"=>"CA", "postal_code"=>"98765", "country_code"=>"US"}}}], "additional_recipients"=>["inform-me@example.com"], "items"=>[{"name"=>"Yoga Mat", "description"=>"new watch", "quantity"=>"1", "unit_amount"=>{"currency_code"=>"USD", "value"=>"50.00"}, "tax"=>{"name"=>"Sales Tax", "percent"=>"7.25"}, "discount"=>{"percent"=>"5"}, "unit_of_measure"=>"QUANTITY"}, {"name"=>"Yoga T Shirt", "quantity"=>"1", "unit_amount"=>{"currency_code"=>"USD", "value"=>"10.00"}, "tax"=>{"name"=>"Sales Tax", "percent"=>"7.25"}, "discount"=>{"amount"=>{"currency_code"=>"USD", "value"=>"5.00"}}, "unit_of_measure"=>"QUANTITY"}], "amount"=>{"currency_code"=>"USD", "breakdown"=>{"custom"=>{"label"=>"Packing Charges", "amount"=>{"currency_code"=>"USD", "value"=>"10.00"}}, "shipping"=>{"amount"=>{"currency_code"=>"USD", "value"=>"10.00"}, "tax"=>{"name"=>"Sales Tax", "percent"=>"7.25"}}, "discount"=>{"invoice_discount"=>{"percent"=>"5"}}}}}, "settings"=>{"template_item_settings"=>[{"field_name"=>"items.date", "display_preference"=>{"hidden"=>true}}, {"field_name"=>"items.discount", "display_preference"=>{"hidden"=>false}}, {"field_name"=>"items.tax", "display_preference"=>{"hidden"=>false}}, {"field_name"=>"items.description", "display_preference"=>{"hidden"=>false}}, {"field_name"=>"items.quantity", "display_preference"=>{"hidden"=>true}}], "template_subtotal_settings"=>[{"field_name"=>"custom", "display_preference"=>{"hidden"=>false}}, {"field_name"=>"discount", "display_preference"=>{"hidden"=>false}}, {"field_name"=>"shipping", "display_preference"=>{"hidden"=>false}}]}, "unit_of_measure"=>"QUANTITY", "standard_template"=>false}

HEADERS

| Key | Datatype | Required | Description | | Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | | PayPal-Request-Id | string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. | | PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | | PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | | PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |

RESPONSES

status: Created

{&quot;id&quot;:&quot;TEMP-0UG25679CA7606120&quot;,&quot;name&quot;:&quot;template_1680891726&quot;,&quot;default_template&quot;:true,&quot;template_info&quot;:{&quot;detail&quot;:{&quot;reference&quot;:&quot;deal-ref&quot;,&quot;currency_code&quot;:&quot;USD&quot;,&quot;note&quot;:&quot;Thank you for your business.&quot;,&quot;terms_and_conditions&quot;:&quot;No refunds after 30 days.&quot;,&quot;memo&quot;:&quot;This is a long contract&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;Screen Shot 2018-11-23 at 16.45.01.png&quot;,&quot;reference_url&quot;:&quot;https://www.sandbox.paypal.com/invoice/payerView/attachments/RkG9ggQbd4Mwm1tYdcF6uuixfFTFq32bBdbE1VbtQLdKSoS2ZOYpfjw9gPp7eTrZmVaFaDWzixHXm-OXWHbmigHigHzURDxJs8IIKqcqP8jawnBEZcraEAPVMULxf5iTyOSpAUc2ugW0PWdwDbM6mg-guFAUyj3Z98H7htWNjQY95jb9heOlcSXUe.sbDUR9smAszzzJoA1NXT6rEEegwQ\u0026version=1\u0026sig=JNODB0xEayW8txMQm6ZsIwDnd4eh3hd6ijiRLi4ipHE&quot;}],&quot;category_code&quot;:&quot;SHIPPABLE&quot;,&quot;payment_term&quot;:{&quot;term_type&quot;:&quot;NET_10&quot;},&quot;metadata&quot;:{&quot;create_time&quot;:&quot;2023-04-07T18:22:06Z&quot;}},&quot;invoicer&quot;:{&quot;name&quot;:{&quot;given_name&quot;:&quot;David&quot;,&quot;surname&quot;:&quot;Larusso&quot;,&quot;full_name&quot;:&quot;David Larusso&quot;},&quot;address&quot;:{&quot;address_line_1&quot;:&quot;1234 First Street&quot;,&quot;address_line_2&quot;:&quot;337673 Hillside Court&quot;,&quot;admin_area_2&quot;:&quot;Anytown&quot;,&quot;admin_area_1&quot;:&quot;CA&quot;,&quot;postal_code&quot;:&quot;98765&quot;,&quot;country_code&quot;:&quot;US&quot;},&quot;email_address&quot;:&quot;merchant@example.com&quot;,&quot;phones&quot;:[{&quot;country_code&quot;:&quot;001&quot;,&quot;national_number&quot;:&quot;4085551234&quot;,&quot;phone_type&quot;:&quot;MOBILE&quot;}],&quot;website&quot;:&quot;www.test.com&quot;,&quot;tax_id&quot;:&quot;ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g&quot;,&quot;additional_notes&quot;:&quot;2-4&quot;,&quot;logo_url&quot;:&quot;https://example.com/logo.PNG&quot;},&quot;primary_recipients&quot;:[{&quot;billing_info&quot;:{&quot;name&quot;:{&quot;given_name&quot;:&quot;Stephanie&quot;,&quot;surname&quot;:&quot;Meyers&quot;,&quot;full_name&quot;:&quot;Stephanie Meyers&quot;},&quot;address&quot;:{&quot;address_line_1&quot;:&quot;1234 Main Street&quot;,&quot;admin_area_2&quot;:&quot;Anytown&quot;,&quot;admin_area_1&quot;:&quot;CA&quot;,&quot;postal_code&quot;:&quot;98765&quot;,&quot;country_code&quot;:&quot;US&quot;},&quot;email_address&quot;:&quot;bill-me@example.com&quot;,&quot;phones&quot;:[{&quot;country_code&quot;:&quot;001&quot;,&quot;national_number&quot;:&quot;4884551234&quot;,&quot;phone_type&quot;:&quot;MOBILE&quot;}],&quot;additional_info&quot;:&quot;add-info&quot;},&quot;shipping_info&quot;:{&quot;name&quot;:{&quot;given_name&quot;:&quot;Stephanie&quot;,&quot;surname&quot;:&quot;Meyers&quot;,&quot;full_name&quot;:&quot;Stephanie Meyers&quot;},&quot;address&quot;:{&quot;address_line_1&quot;:&quot;1234 Main Street&quot;,&quot;admin_area_2&quot;:&quot;Anytown&quot;,&quot;admin_area_1&quot;:&quot;CA&quot;,&quot;postal_code&quot;:&quot;98765&quot;,&quot;country_code&quot;:&quot;US&quot;}}}],&quot;additional_recipients&quot;:[&quot;inform-me@example.com&quot;],&quot;items&quot;:[{&quot;id&quot;:&quot;ITEM-9TT77522YP7347512&quot;,&quot;name&quot;:&quot;Yoga Mat&quot;,&quot;description&quot;:&quot;new watch&quot;,&quot;quantity&quot;:&quot;1&quot;,&quot;unit_amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;50.00&quot;},&quot;tax&quot;:{&quot;id&quot;:&quot;TAX-4U207526VK027114E&quot;,&quot;name&quot;:&quot;Sales Tax&quot;,&quot;percent&quot;:&quot;7.25&quot;},&quot;discount&quot;:{&quot;percent&quot;:&quot;5&quot;},&quot;unit_of_measure&quot;:&quot;QUANTITY&quot;},{&quot;id&quot;:&quot;ITEM-9NR29244PS733303B&quot;,&quot;name&quot;:&quot;Yoga T Shirt&quot;,&quot;quantity&quot;:&quot;1&quot;,&quot;unit_amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;10.00&quot;},&quot;tax&quot;:{&quot;id&quot;:&quot;TAX-4U207526VK027114E&quot;,&quot;name&quot;:&quot;Sales Tax&quot;,&quot;percent&quot;:&quot;7.25&quot;},&quot;discount&quot;:{&quot;amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;-5.00&quot;}},&quot;unit_of_measure&quot;:&quot;QUANTITY&quot;}],&quot;configuration&quot;:{&quot;tax_calculated_after_discount&quot;:true,&quot;tax_inclusive&quot;:false,&quot;allow_tip&quot;:true,&quot;partial_payment&quot;:{&quot;allow_partial_payment&quot;:true,&quot;minimum_amount_due&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;20.00&quot;}}},&quot;amount&quot;:{&quot;breakdown&quot;:{&quot;discount&quot;:{&quot;invoice_discount&quot;:{&quot;percent&quot;:&quot;5&quot;}},&quot;shipping&quot;:{&quot;amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;10.00&quot;},&quot;tax&quot;:{&quot;id&quot;:&quot;TAX-4U207526VK027114E&quot;,&quot;name&quot;:&quot;Sales Tax&quot;,&quot;percent&quot;:&quot;7.25&quot;}},&quot;custom&quot;:{&quot;label&quot;:&quot;Packing Charges&quot;,&quot;amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;10.00&quot;}}}}},&quot;settings&quot;:{&quot;template_item_settings&quot;:[{&quot;field_name&quot;:&quot;items.date&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:true}},{&quot;field_name&quot;:&quot;items.discount&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}},{&quot;field_name&quot;:&quot;items.tax&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}},{&quot;field_name&quot;:&quot;items.description&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}},{&quot;field_name&quot;:&quot;items.quantity&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:true}}],&quot;template_subtotal_settings&quot;:[{&quot;field_name&quot;:&quot;custom&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}},{&quot;field_name&quot;:&quot;discount&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}},{&quot;field_name&quot;:&quot;shipping&quot;,&quot;display_preference&quot;:{&quot;hidden&quot;:false}}]},&quot;unit_of_measure&quot;:&quot;QUANTITY&quot;,&quot;standard_template&quot;:false,&quot;links&quot;:[{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/templates/TEMP-0UG25679CA7606120&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;GET&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/templates/TEMP-0UG25679CA7606120&quot;,&quot;rel&quot;:&quot;delete&quot;,&quot;method&quot;:&quot;DELETE&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/templates/TEMP-0UG25679CA7606120&quot;,&quot;rel&quot;:&quot;replace&quot;,&quot;method&quot;:&quot;PUT&quot;}]}