Qodex.ai

Create draft invoice

POST {{base_url}}/v2/invoicing/invoices

Creates a draft invoice. To move the invoice from a draft to payable state, you must send the invoice .

In the JSON request body, include invoice details including merchant information. The invoice object must include an items array.

Note: The merchant that you specify in an invoice must have a PayPal account in good standing.
.

Request Body

{"detail"=>{"invoice_number"=>"{{draft_invoice_number}}", "invoice_date"=>"2022-02-04", "payment_term"=>{"term_type"=>"NET_10", "due_date"=>"2022-02-14"}, "currency_code"=>"USD", "reference"=>"<The reference data. Includes a post office (PO) number.>", "note"=>"<A note to the invoice recipient. Also appears on the invoice notification email.>", "terms_and_conditions"=>"<The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.>", "memo"=>"<A private bookkeeping note for merchant.>"}, "invoicer"=>{"name"=>{"given_name"=>"David", "surname"=>"Larusso"}, "address"=>{"address_line_1"=>"123 Townsend St", "address_line_2"=>"Floor 6", "admin_area_2"=>"San Francisco", "admin_area_1"=>"CA", "postal_code"=>"94107", "country_code"=>"US"}, "phones"=>[{"country_code"=>"001", "national_number"=>"4085551234", "phone_type"=>"MOBILE"}], "website"=>"www.example.com", "tax_id"=>"XX-XXXXXXX", "logo_url"=>"https://example.com/logo.png", "additional_notes"=>"<Any additional information. Includes business hours.>"}, "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"=>"foobuyer@example.com", "phones"=>[{"country_code"=>"001", "national_number"=>"4884551234", "phone_type"=>"HOME"}], "additional_info_value"=>"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"}}}], "items"=>[{"name"=>"Yoga Mat", "description"=>"Elastic mat to practice yoga.", "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"}], "configuration"=>{"partial_payment"=>{"allow_partial_payment"=>true, "minimum_amount_due"=>{"currency_code"=>"USD", "value"=>"20.00"}}, "allow_tip"=>true, "tax_calculated_after_discount"=>true, "tax_inclusive"=>false}, "amount"=>{"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"}}}}}

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;INV2-APM2-WC6A-8J5E-BLVW&quot;,&quot;status&quot;:&quot;DRAFT&quot;,&quot;detail&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;category_code&quot;:&quot;SHIPPABLE&quot;,&quot;invoice_number&quot;:&quot;1644276919&quot;,&quot;invoice_date&quot;:&quot;2022-02-07&quot;,&quot;payment_term&quot;:{&quot;term_type&quot;:&quot;NO_DUE_DATE&quot;},&quot;viewed_by_recipient&quot;:false,&quot;group_draft&quot;:false,&quot;metadata&quot;:{&quot;create_time&quot;:&quot;2022-02-07T23:36:47Z&quot;,&quot;last_update_time&quot;:&quot;2022-02-07T23:36:47Z&quot;,&quot;created_by_flow&quot;:&quot;REGULAR_SINGLE&quot;,&quot;recipient_view_url&quot;:&quot;https://www.sandbox.paypal.com/invoice/p/#APM2WC6A8J5EBLVW&quot;,&quot;invoicer_view_url&quot;:&quot;https://www.sandbox.paypal.com/invoice/details/INV2-APM2-WC6A-8J5E-BLVW&quot;,&quot;caller_type&quot;:&quot;API_V2_INVOICE&quot;},&quot;archived&quot;:false},&quot;invoicer&quot;:{},&quot;configuration&quot;:{&quot;tax_calculated_after_discount&quot;:false,&quot;tax_inclusive&quot;:false,&quot;allow_tip&quot;:false,&quot;template_id&quot;:&quot;TEMP-1L131815AG126341C&quot;},&quot;amount&quot;:{&quot;breakdown&quot;:{&quot;discount&quot;:{&quot;invoice_discount&quot;:{&quot;amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;0.00&quot;}},&quot;item_discount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;0.00&quot;}},&quot;tax_total&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;0.00&quot;}},&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;0.00&quot;},&quot;due_amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;0.00&quot;},&quot;links&quot;:[{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-APM2-WC6A-8J5E-BLVW&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;GET&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-APM2-WC6A-8J5E-BLVW/send&quot;,&quot;rel&quot;:&quot;send&quot;,&quot;method&quot;:&quot;POST&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-APM2-WC6A-8J5E-BLVW&quot;,&quot;rel&quot;:&quot;replace&quot;,&quot;method&quot;:&quot;PUT&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-APM2-WC6A-8J5E-BLVW&quot;,&quot;rel&quot;:&quot;delete&quot;,&quot;method&quot;:&quot;DELETE&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-APM2-WC6A-8J5E-BLVW/payments&quot;,&quot;rel&quot;:&quot;record-payment&quot;,&quot;method&quot;:&quot;POST&quot;}]}