Templates
Lists merchant-created templates with associated details.
Table Specific Information
Select
The only filter supported by the PayPal API is Id. Server-side processing is only supported for the '=' operator.
Select * from Templates where Id = 'TEMP-3RK55758SK521635N'
The 本製品 processes other filters client side within the 本製品.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the template. | |
| Name | String | The template name. | |
| DefaultTemplate | Boolean | Indicates whether this template is the default template. | |
| StandardTemplate | Boolean | Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates. | |
| Links | String | An array of request-related HATEOAS links. | |
| TemplateInfoDetailReference | String | The reference data. Includes a Purchase Order (PO) number. | |
| TemplateInfoDetailNote | String | A note to the invoice recipient. Also appears on the invoice notification email. | |
| TemplateInfoDetailTermsAndConditions | String | The general terms of the invoice. Can include return or cancellation policy and other terms and conditions. | |
| TemplateInfoDetailMemo | String | A private bookkeeping memo for the user. | |
| TemplateInfoDetailCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoDetailPaymentTermType | String | The payment term. Payment can be due upon receipt, a specified date, or in a set number of days. | |
| TemplateInfoMetadataCreatedBy | String | The email address of the account that created the resource. | |
| TemplateInfoMetadataLastUpdatedBy | String | The email address of the account that last edited the resource. | |
| TemplateInfoMetadataCreateTime | Datetime | The date and time, in Internet date and time format. | |
| TemplateInfoMetadataLastUpdateTime | Datetime | The date and time, in Internet date and time format. | |
| TemplateInfoInvoicerBusinessName | String | The business name of the party. | |
| TemplateInfoInvoicerPrefixName | String | The prefix, or title, to the party's name. | |
| TemplateInfoInvoicerFirstName | String | When the party is a person, the party's given, or first, name. | |
| TemplateInfoInvoicerMiddleName | String | When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. | |
| TemplateInfoInvoicerLastName | String | When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. | |
| TemplateInfoInvoicerSuffixName | String | The suffix for the party's name. | |
| TemplateInfoInvoicerFullName | String | When the party is a person, the party's full name. | |
| TemplateInfoInvoicerAddressLine1 | String | The first line of the address. For example, number or street. | |
| TemplateInfoInvoicerAddressLine2 | String | The second line of the address. For example, suite or apartment number. | |
| TemplateInfoInvoicerAddressLine3 | String | The third line of the address, if needed. | |
| TemplateInfoInvoicerAddressAdminArea1 | String | The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. | |
| TemplateInfoInvoicerAddressAdminArea2 | String | A city, town, or village. | |
| TemplateInfoInvoicerAddressAdminArea3 | String | A sub-locality, suburb, neighborhood, or district. | |
| TemplateInfoInvoicerAddressAdminArea4 | String | The neighborhood, ward, or district. | |
| TemplateInfoInvoicerAddressPostalCode | String | The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. | |
| TemplateInfoInvoicerAddressCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region. | |
| TemplateInfoInvoicerAddressStreetNumber | String | The street number. | |
| TemplateInfoInvoicerAddressStreetName | String | The street name. Just Drury in Drury Lane. | |
| TemplateInfoInvoicerAddressStreetType | String | The street type. For example, avenue, boulevard, road, or expressway. | |
| TemplateInfoInvoicerAddressDeliveryService | String | The delivery service. Post office box, bag number, or post office name. | |
| TemplateInfoInvoicerAddressBuildingName | String | A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. | |
| TemplateInfoInvoicerAddressSubBuilding | String | The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. | |
| TemplateInfoInvoicerPhones | String | An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice. | |
| TemplateInfoInvoicerWebsite | String | The invoicer's website. | |
| TemplateInfoInvoicerTaxId | String | The invoicer's tax ID. | |
| TemplateInfoInvoicerAdditionalNotes | String | Any additional information. Includes business hours. | |
| TemplateInfoInvoicerLogoUrl | String | The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high. | |
| TemplateInfoInvoicerEmail | String | The invoicer email address, which must be listed in the user's PayPal profile. | |
| TemplateInfoConfigurationTaxCalculatedAfterDiscount | Boolean | Indicates whether the tax is calculated before or after a discount. | |
| TemplateInfoConfigurationTaxInclusive | Boolean | Indicates whether the unit price includes tax. | |
| TemplateInfoConfigurationAllowTip | Boolean | Indicates whether the invoice enables the customer to enter a tip amount during payment. | |
| TemplateInfoConfigurationAllowPartialPayment | Boolean | Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments. | |
| TemplateInfoConfigurationMinimumAmountDue | Decimal | The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true. | |
| TemplateInfoConfigurationMinimumAmountDueCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountValue | Decimal | The invoice amount summary of item total, discount, tax total and shipping. | |
| TemplateInfoAmountCurrencyCode | String | The invoice amount summary of item total, discount, tax total and shipping. | |
| TemplateInfoAmountBreakdownItemTotalValue | Decimal | The amount for a financial transaction, such as a balance or payment due. | |
| TemplateInfoAmountBreakdownItemTotalCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownInvoiceDiscountPercentage | Decimal | The discount as a percentage value. Value is from 0 to 100. | |
| TemplateInfoAmountBreakdownInvoiceDiscountValue | Decimal | The invoice level discount amount. | |
| TemplateInfoAmountBreakdownInvoiceDiscountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownItemDiscountValue | Decimal | The amount for a financial transaction, such as a balance or payment due. | |
| TemplateInfoAmountBreakdownItemDiscountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownTaxTotalValue | Decimal | The amount for a financial transaction, such as a balance or payment due. | |
| TemplateInfoAmountBreakdownTaxTotalCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownShippingAmountValue | Decimal | The shipping fee for all items. Includes tax on shipping. | |
| TemplateInfoAmountBreakdownShippingAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownShippingTaxAmountValue | Decimal | The calculated tax amount. The tax amount is added to the item total. | |
| TemplateInfoAmountBreakdownShippingTaxAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoAmountBreakdownShippingTaxPercentage | Decimal | The tax rate. | |
| TemplateInfoAmountBreakdownShippingTaxName | String | The name of the tax applied on the invoice items. | |
| TemplateInfoAmountBreakdownShippingTaxNote | String | The tax note used to track the tax related data. | |
| TemplateInfoAmountBreakdownCustomLabel | String | The label to the custom amount of the invoice. | |
| TemplateInfoAmountBreakdownCustomAmountValue | Decimal | The custom amount to apply to an invoice. | |
| TemplateInfoAmountBreakdownCustomAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| TemplateInfoDueAmountValue | Decimal | The amount for a financial transaction, such as a balance or payment due. | |
| TemplateInfoDueAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| ItemSettings | String | The template item headers display preference. | |
| SubtotalSettings | String | The template subtotal headers display preference. | |
| UnitOfMeasure | String | The unit of measure for the invoiced item.
使用できる値は次のとおりです。QUANTITY, HOURS, AMOUNT |