❮❮ Back to Samples

Request Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com",
            "business_name": "Jay Inc",
            "additional_info": "This is the billing Info",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            }
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "1",
                "name": "Local Tax on Sutures"
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "discount": {
                "percent": "3.00"
            },
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "3",
                "name": "Local Tax on Injection"
            }
        }
    ],
    "discount": {
        "percent": "2.00"
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg"
}

Response Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com",
            "business_name": "Jay Inc",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            },
            "additional_info": "This is the billing Info"
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-03-17 PDT"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Sutures",
                "percent": "1",
                "amount": {
                    "currency": "USD",
                    "value": "5.00"
                }
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Injection",
                "percent": "3",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            },
            "discount": {
                "percent": "3.00",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            }
        }
    ],
    "discount": {
        "percent": "2.00",
        "amount": {
            "currency": "USD",
            "value": "10.49"
        }
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg",
    "id": "INV2-VPVS-L7VQ-7FUW-UDGX",
    "number": "INV-20180727197663",
    "template_id": "TEMP-2951065150453822S",
    "status": "DRAFT",
    "invoice_date": "2025-01-31 PST",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "519.51"
    },
    "metadata": {
        "created_date": "2025-01-31 02:08:13 PST"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/record-payment",
            "method": "POST"
        }
    ]
}

Request Object

Response Object

{
    "total_count": 211356,
    "invoices": [
        {
            "id": "INV2-VPVS-L7VQ-7FUW-UDGX",
            "number": "INV-20180727197663",
            "status": "DRAFT",
            "merchant_info": {
                "email": "jaypatel512-facilitator@hotmail.com"
            },
            "billing_info": [
                {
                    "email": "example@example.com",
                    "business_name": "Jay Inc"
                }
            ],
            "shipping_info": {
                "email": "example@example.com",
                "first_name": "Sally",
                "last_name": "Patient",
                "business_name": "Not applicable"
            },
            "invoice_date": "2025-01-31 PST",
            "payment_term": {
                "due_date": "2025-03-17 PDT"
            },
            "note": "Medical Invoice 16 Jul, 2013 PST",
            "total_amount": {
                "currency": "USD",
                "value": "519.51"
            },
            "metadata": {
                "created_date": "2025-01-31 02:08:13 PST"
            },
            "paid_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "refunded_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX",
                    "method": "GET"
                },
                {
                    "rel": "send",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/send",
                    "method": "POST"
                },
                {
                    "rel": "replace",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/update",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX",
                    "method": "DELETE"
                },
                {
                    "rel": "record-payment",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-VPVS-L7VQ-7FUW-UDGX/record-payment",
                    "method": "POST"
                }
            ]
        },
        {
            "id": "INV2-JT29-49KK-QCRR-LYF6",
            "number": "INV-20180727197662",
            "status": "DRAFT",
            "merchant_info": {
                "email": "jaypatel512-facilitator@hotmail.com"
            },
            "billing_info": [
                {
                    "email": "example@example.com",
                    "business_name": "Jay Inc"
                }
            ],
            "shipping_info": {
                "email": "example@example.com",
                "first_name": "Sally",
                "last_name": "Patient",
                "business_name": "Not applicable"
            },
            "invoice_date": "2025-01-31 PST",
            "payment_term": {
                "due_date": "2025-03-17 PDT"
            },
            "note": "Medical Invoice 16 Jul, 2013 PST",
            "total_amount": {
                "currency": "USD",
                "value": "519.51"
            },
            "metadata": {
                "created_date": "2025-01-31 02:07:05 PST"
            },
            "paid_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "refunded_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-JT29-49KK-QCRR-LYF6",
                    "method": "GET"
                },
                {
                    "rel": "send",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-JT29-49KK-QCRR-LYF6/send",
                    "method": "POST"
                },
                {
                    "rel": "replace",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-JT29-49KK-QCRR-LYF6/update",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-JT29-49KK-QCRR-LYF6",
                    "method": "DELETE"
                },
                {
                    "rel": "record-payment",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-JT29-49KK-QCRR-LYF6/record-payment",
                    "method": "POST"
                }
            ]
        },
        {
            "id": "INV2-YR32-XT35-LSS7-KAYX",
            "number": "INV-20180727197661",
            "status": "SENT",
            "merchant_info": {
                "email": "jaypatel512-facilitator@hotmail.com"
            },
            "billing_info": [
                {
                    "email": "example@example.com",
                    "business_name": "Jay Inc"
                }
            ],
            "shipping_info": {
                "email": "example@example.com",
                "first_name": "Sally",
                "last_name": "Patient",
                "business_name": "Not applicable"
            },
            "invoice_date": "2025-01-31 PST",
            "payment_term": {
                "due_date": "2025-03-17 PDT"
            },
            "note": "Medical Invoice 16 Jul, 2013 PST",
            "total_amount": {
                "currency": "USD",
                "value": "519.51"
            },
            "metadata": {
                "created_date": "2025-01-31 02:03:53 PST",
                "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-YR32-XT35-LSS7-KAYX"
            },
            "paid_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "refunded_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "0.00"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX",
                    "method": "GET"
                },
                {
                    "rel": "replace",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX/update",
                    "method": "PUT"
                },
                {
                    "rel": "cancel",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX/cancel",
                    "method": "POST"
                },
                {
                    "rel": "remind",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX/remind",
                    "method": "POST"
                },
                {
                    "rel": "record-payment",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX/record-payment",
                    "method": "POST"
                },
                {
                    "rel": "qr-code",
                    "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-YR32-XT35-LSS7-KAYX/qr-code",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "INV2-LDG4-7TRQ-W2XH-TGPM",
            "number": "INV-20180727197660",
            "status": "MARKED_AS_REFUNDED",
            "merchant_info": {
                "email": "jaypatel512-facilitator@hotmail.com"
            },
            "billing_info": [
                {
                    "email": "example@example.com",
                    "business_name": "Jay Inc"
                }
            ],
            "shipping_info": {
                "email": "example@example.com",
                "first_name": "Sally",
                "last_name": "Patient",
                "business_name": "Not applicable"
            },
            "invoice_date": "2025-01-31 PST",
            "payment_term": {
                "due_date": "2025-03-17 PDT"
            },
            "note": "Medical Invoice 16 Jul, 2013 PST",
            "total_amount": {
                "currency": "USD",
                "value": "519.51"
            },
            "metadata": {
                "created_date": "2025-01-31 02:03:40 PST"
            },
            "paid_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "519.51"
                }
            },
            "refunded_amount": {
                "paypal": {
                    "currency": "USD",
                    "value": "0.00"
                },
                "other": {
                    "currency": "USD",
                    "value": "519.51"
                }
            }
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=0&page_size=4&total_count_required=true",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=1&page_size=4&total_count_required=true",
            "method": "GET"
        },
        {
            "rel": "prev",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=-1&page_size=4&total_count_required=true",
            "method": "GET"
        }
    ]
}