{ "name": "UpdateInvoice", "fully_qualified_name": "SquareupApi.UpdateInvoice@2.0.0", "description": "Updates invoice details with specified changes.\n\nUse this tool to update fields in an existing invoice. Only the fields you wish to change need to be specified, along with the required `version` field. Note that some restrictions apply, such as the inability to change fields like `order_id` or `location_id`.", "toolkit": { "name": "ArcadeSquareupApi", "description": null, "version": "2.0.0" }, "input": { "parameters": [ { "name": "invoice_id", "required": true, "description": "The unique ID of the invoice you wish to update.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the invoice to update." }, "inferrable": true, "http_endpoint_parameter_name": "invoice_id" }, { "name": "invoice_update_fields", "required": true, "description": "A JSON object with the fields to update on the invoice. Required fields: `version`. Restrictions: cannot update `order_id` or `location_id`.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "invoice": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned ID of the invoice." }, "version": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned version number, which is incremented each time an update is committed to the invoice." }, "location_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the location that this invoice is associated with. \n\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order." }, "order_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [order](entity:Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID." }, "primary_recipient": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "customer_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the customer. This is the customer profile ID that \nyou provide when creating a draft invoice." }, "given_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's given (that is, first) name." }, "family_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's family (that is, last) name." }, "email_address": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's email address." }, "address": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "address_line_1": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)." }, "address_line_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The second line of the address, if any." }, "address_line_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The third line of the address, if any." }, "locality": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "sublocality": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `locality`, if any." }, "sublocality_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `sublocality`, if any." }, "sublocality_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `sublocality_2`, if any." }, "administrative_district_level_1": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "administrative_district_level_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county." }, "administrative_district_level_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's `administrative_district_level_2`,\nif any." }, "postal_code": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "country": { "val_type": "string", "inner_val_type": null, "enum": [ "ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "properties": null, "inner_properties": null, "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)." }, "first_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Optional first name when it's representing recipient." }, "last_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Optional last name when it's representing recipient." } }, "inner_properties": null, "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "phone_number": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's phone number." }, "company_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the recipient's company." }, "tax_ids": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "eu_vat": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The EU VAT identification number for the invoice recipient. For example, `IE3426675K`." } }, "inner_properties": null, "description": "Represents the tax IDs for an invoice recipient. The country of the seller account determines \nwhether the corresponding `tax_ids` field is available for the customer. For more information, \nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids)." } }, "inner_properties": null, "description": "Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \nand that Square uses to deliver the invoice.\n\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \nSquare updates the customer ID in response to a merge operation, but does not update other fields." }, "payment_requests": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "uid": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-generated ID of the payment request in an [invoice](entity:Invoice)." }, "request_method": { "val_type": "string", "inner_val_type": null, "enum": [ "EMAIL", "CHARGE_CARD_ON_FILE", "SHARE_MANUALLY", "CHARGE_BANK_ON_FILE", "SMS", "SMS_CHARGE_CARD_ON_FILE", "SMS_CHARGE_BANK_ON_FILE" ], "properties": null, "inner_properties": null, "description": "Specifies the action for Square to take for processing the invoice. For example, \nemail the invoice, charge a customer's card on file, or do nothing. DEPRECATED at\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields." }, "request_type": { "val_type": "string", "inner_val_type": null, "enum": [ "BALANCE", "DEPOSIT", "INSTALLMENT" ], "properties": null, "inner_properties": null, "description": "Indicates the type of the payment request. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests)." }, "due_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\ncharges the payment source on this date.\n\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\nof America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC\ntimestamp of 2021-03-10T08:00:00Z)." }, "fixed_amount_requested_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "percentage_requested": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specifies the amount for the payment request in percentage:\n\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount.\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less \nthe deposit, if requested. The sum of the `percentage_requested` in all installment \npayment requests must be equal to 100.\n\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \npayment request specifies the `fixed_amount_requested_money` field." }, "tipping_enabled": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \nprovides a place for the customer to pay a tip. \n\nThis field is allowed only on the final payment request \nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`." }, "automatic_payment_source": { "val_type": "string", "inner_val_type": null, "enum": [ "NONE", "CARD_ON_FILE", "BANK_ON_FILE" ], "properties": null, "inner_properties": null, "description": "Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest)." }, "card_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient." }, "reminders": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "uid": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A Square-assigned ID that uniquely identifies the reminder within the\n`InvoicePaymentRequest`." }, "relative_scheduled_days": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The number of days before (a negative number) or after (a positive number)\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\nthe reminder should be sent 3 days before the payment request `due_date`." }, "message": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The reminder message." }, "status": { "val_type": "string", "inner_val_type": null, "enum": [ "PENDING", "NOT_APPLICABLE", "SENT" ], "properties": null, "inner_properties": null, "description": "The status of a payment request reminder." }, "sent_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If sent, the timestamp when the reminder was sent, in RFC 3339 format." } }, "description": "A list of one or more reminders to send for the payment request." }, "computed_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "total_completed_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "rounding_adjustment_included_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." } }, "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2\u201312 installments \n- One deposit with 2\u201312 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." }, "delivery_method": { "val_type": "string", "inner_val_type": null, "enum": [ "EMAIL", "SHARE_MANUALLY", "SMS" ], "properties": null, "inner_properties": null, "description": "Indicates how Square delivers the [invoice](entity:Invoice) to the customer." }, "invoice_number": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\nIf not provided when creating an invoice, Square assigns a value.\nIt increments from 1 and is padded with zeros making it 7 characters long\n(for example, 0000001 and 0000002)." }, "title": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The title of the invoice, which is displayed on the invoice." }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The description of the invoice, which is displayed on the invoice." }, "scheduled_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\nAfter the invoice is published, Square processes the invoice on the specified date,\naccording to the delivery method and payment request settings.\n\nIf the field is not set, Square processes the invoice immediately after it is published." }, "public_url": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A temporary link to the Square-hosted payment page where the customer can pay the\ninvoice. If the link expires, customers can provide the email address or phone number\nassociated with the invoice and request a new link directly from the expired payment page. \n\nThis field is added after the invoice is published and reaches the scheduled date\n(if one is defined)." }, "next_payment_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "status": { "val_type": "string", "inner_val_type": null, "enum": [ "DRAFT", "UNPAID", "SCHEDULED", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED", "CANCELED", "FAILED", "PAYMENT_PENDING" ], "properties": null, "inner_properties": null, "description": "Indicates the status of an [invoice](entity:Invoice)." }, "timezone": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The time zone used to interpret calendar dates on the invoice, such as `due_date`.\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\nlocation. The value cannot be changed.\n\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles\nbecomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp\nof 2021-03-10T08:00:00Z)." }, "created_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice was created, in RFC 3339 format." }, "updated_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice was last updated, in RFC 3339 format." }, "accepted_payment_methods": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "card": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether credit card or debit card payments are accepted. The default value is `false`." }, "square_gift_card": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Square gift card payments are accepted. The default value is `false`." }, "bank_account": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether ACH bank transfer payments are accepted. The default value is `false`." }, "buy_now_pay_later": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later)." }, "cash_app_pay": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](entity:Location) in the United States." } }, "inner_properties": null, "description": "The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page." }, "custom_fields": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "label": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The label or title of the custom field. This field is required for a custom field." }, "value": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The text of the custom field. If omitted, only the label is rendered." }, "placement": { "val_type": "string", "inner_val_type": null, "enum": [ "ABOVE_LINE_ITEMS", "BELOW_LINE_ITEMS" ], "properties": null, "inner_properties": null, "description": "Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \ncopies of the invoice." } }, "description": "Additional seller-defined fields that are displayed on the invoice. For more information, see\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\n\nMax: 2 custom fields" }, "subscription_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [subscription](entity:Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices." }, "sale_or_service_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\nThis field can be used to specify a past or future date which is displayed on the invoice." }, "payment_conditions": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\n\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \n\"Payment conditions are not supported for this location's country\" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests." }, "store_payment_method_enabled": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`." }, "attachments": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned ID of the attachment." }, "filename": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The file name of the attachment, which is displayed on the invoice." }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The description of the attachment, which is displayed on the invoice.\nThis field maps to the seller-defined **Message** field." }, "filesize": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The file size of the attachment in bytes." }, "hash": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The MD5 hash that was generated from the file contents." }, "mime_type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The mime type of the attachment.\nThe following mime types are supported: \nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf." }, "uploaded_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the attachment was uploaded, in RFC 3339 format." } }, "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints." }, "creator_team_member_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [team member](entity:TeamMember) who created the invoice.\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member." } }, "inner_properties": null, "description": "Stores information about an invoice. You use the Invoices API to create and manage\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview)." }, "idempotency_key": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A unique string that identifies the `UpdateInvoice` request. If you do not\nprovide `idempotency_key` (or provide an empty string as the value), the endpoint\ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." }, "fields_to_clear": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "The list of fields to clear. Although this field is currently supported, we\nrecommend using null values or the `remove` field when possible. For examples, see\n[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices)." } }, "inner_properties": null, "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details." }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'UpdateInvoice'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-squareup", "provider_type": "oauth2", "id": null, "oauth2": { "scopes": [ "INVOICES_WRITE", "ORDERS_WRITE" ] } }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the squareup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://connect.squareup.com/v2/invoices/{invoice_id}", "http_method": "PUT", "headers": {}, "parameters": [ { "name": "invoice_id", "tool_parameter_name": "invoice_id", "description": "The ID of the invoice to update.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the invoice to update." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "requestBody", "tool_parameter_name": "invoice_update_fields", "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "invoice": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned ID of the invoice." }, "version": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned version number, which is incremented each time an update is committed to the invoice." }, "location_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the location that this invoice is associated with. \n\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order." }, "order_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [order](entity:Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID." }, "primary_recipient": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "customer_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the customer. This is the customer profile ID that \nyou provide when creating a draft invoice." }, "given_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's given (that is, first) name." }, "family_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's family (that is, last) name." }, "email_address": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's email address." }, "address": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "address_line_1": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)." }, "address_line_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The second line of the address, if any." }, "address_line_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The third line of the address, if any." }, "locality": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "sublocality": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `locality`, if any." }, "sublocality_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `sublocality`, if any." }, "sublocality_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil region within the address's `sublocality_2`, if any." }, "administrative_district_level_1": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "administrative_district_level_2": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county." }, "administrative_district_level_3": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A civil entity within the address's `administrative_district_level_2`,\nif any." }, "postal_code": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "country": { "val_type": "string", "inner_val_type": null, "enum": [ "ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "properties": null, "inner_properties": null, "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)." }, "first_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Optional first name when it's representing recipient." }, "last_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Optional last name when it's representing recipient." } }, "inner_properties": null, "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)." }, "phone_number": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The recipient's phone number." }, "company_name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the recipient's company." }, "tax_ids": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "eu_vat": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The EU VAT identification number for the invoice recipient. For example, `IE3426675K`." } }, "inner_properties": null, "description": "Represents the tax IDs for an invoice recipient. The country of the seller account determines \nwhether the corresponding `tax_ids` field is available for the customer. For more information, \nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids)." } }, "inner_properties": null, "description": "Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \nand that Square uses to deliver the invoice.\n\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \nSquare updates the customer ID in response to a merge operation, but does not update other fields." }, "payment_requests": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "uid": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-generated ID of the payment request in an [invoice](entity:Invoice)." }, "request_method": { "val_type": "string", "inner_val_type": null, "enum": [ "EMAIL", "CHARGE_CARD_ON_FILE", "SHARE_MANUALLY", "CHARGE_BANK_ON_FILE", "SMS", "SMS_CHARGE_CARD_ON_FILE", "SMS_CHARGE_BANK_ON_FILE" ], "properties": null, "inner_properties": null, "description": "Specifies the action for Square to take for processing the invoice. For example, \nemail the invoice, charge a customer's card on file, or do nothing. DEPRECATED at\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields." }, "request_type": { "val_type": "string", "inner_val_type": null, "enum": [ "BALANCE", "DEPOSIT", "INSTALLMENT" ], "properties": null, "inner_properties": null, "description": "Indicates the type of the payment request. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests)." }, "due_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\ncharges the payment source on this date.\n\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\nof America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC\ntimestamp of 2021-03-10T08:00:00Z)." }, "fixed_amount_requested_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "percentage_requested": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Specifies the amount for the payment request in percentage:\n\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount.\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less \nthe deposit, if requested. The sum of the `percentage_requested` in all installment \npayment requests must be equal to 100.\n\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \npayment request specifies the `fixed_amount_requested_money` field." }, "tipping_enabled": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \nprovides a place for the customer to pay a tip. \n\nThis field is allowed only on the final payment request \nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`." }, "automatic_payment_source": { "val_type": "string", "inner_val_type": null, "enum": [ "NONE", "CARD_ON_FILE", "BANK_ON_FILE" ], "properties": null, "inner_properties": null, "description": "Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest)." }, "card_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient." }, "reminders": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "uid": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A Square-assigned ID that uniquely identifies the reminder within the\n`InvoicePaymentRequest`." }, "relative_scheduled_days": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The number of days before (a negative number) or after (a positive number)\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\nthe reminder should be sent 3 days before the payment request `due_date`." }, "message": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The reminder message." }, "status": { "val_type": "string", "inner_val_type": null, "enum": [ "PENDING", "NOT_APPLICABLE", "SENT" ], "properties": null, "inner_properties": null, "description": "The status of a payment request reminder." }, "sent_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If sent, the timestamp when the reminder was sent, in RFC 3339 format." } }, "description": "A list of one or more reminders to send for the payment request." }, "computed_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "total_completed_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "rounding_adjustment_included_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." } }, "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2\u201312 installments \n- One deposit with 2\u201312 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)." }, "delivery_method": { "val_type": "string", "inner_val_type": null, "enum": [ "EMAIL", "SHARE_MANUALLY", "SMS" ], "properties": null, "inner_properties": null, "description": "Indicates how Square delivers the [invoice](entity:Invoice) to the customer." }, "invoice_number": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\nIf not provided when creating an invoice, Square assigns a value.\nIt increments from 1 and is padded with zeros making it 7 characters long\n(for example, 0000001 and 0000002)." }, "title": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The title of the invoice, which is displayed on the invoice." }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The description of the invoice, which is displayed on the invoice." }, "scheduled_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\nAfter the invoice is published, Square processes the invoice on the specified date,\naccording to the delivery method and payment request settings.\n\nIf the field is not set, Square processes the invoice immediately after it is published." }, "public_url": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A temporary link to the Square-hosted payment page where the customer can pay the\ninvoice. If the link expires, customers can provide the email address or phone number\nassociated with the invoice and request a new link directly from the expired payment page. \n\nThis field is added after the invoice is published and reaches the scheduled date\n(if one is defined)." }, "next_payment_amount_money": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "amount": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." }, "currency": { "val_type": "string", "inner_val_type": null, "enum": [ "UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS" ], "properties": null, "inner_properties": null, "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)." } }, "inner_properties": null, "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." }, "status": { "val_type": "string", "inner_val_type": null, "enum": [ "DRAFT", "UNPAID", "SCHEDULED", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED", "CANCELED", "FAILED", "PAYMENT_PENDING" ], "properties": null, "inner_properties": null, "description": "Indicates the status of an [invoice](entity:Invoice)." }, "timezone": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The time zone used to interpret calendar dates on the invoice, such as `due_date`.\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\nlocation. The value cannot be changed.\n\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles\nbecomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp\nof 2021-03-10T08:00:00Z)." }, "created_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice was created, in RFC 3339 format." }, "updated_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the invoice was last updated, in RFC 3339 format." }, "accepted_payment_methods": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "card": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether credit card or debit card payments are accepted. The default value is `false`." }, "square_gift_card": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Square gift card payments are accepted. The default value is `false`." }, "bank_account": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether ACH bank transfer payments are accepted. The default value is `false`." }, "buy_now_pay_later": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later)." }, "cash_app_pay": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](entity:Location) in the United States." } }, "inner_properties": null, "description": "The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page." }, "custom_fields": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "label": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The label or title of the custom field. This field is required for a custom field." }, "value": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The text of the custom field. If omitted, only the label is rendered." }, "placement": { "val_type": "string", "inner_val_type": null, "enum": [ "ABOVE_LINE_ITEMS", "BELOW_LINE_ITEMS" ], "properties": null, "inner_properties": null, "description": "Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \ncopies of the invoice." } }, "description": "Additional seller-defined fields that are displayed on the invoice. For more information, see\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\n\nMax: 2 custom fields" }, "subscription_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [subscription](entity:Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices." }, "sale_or_service_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\nThis field can be used to specify a past or future date which is displayed on the invoice." }, "payment_conditions": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\n\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \n\"Payment conditions are not supported for this location's country\" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests." }, "store_payment_method_enabled": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`." }, "attachments": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The Square-assigned ID of the attachment." }, "filename": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The file name of the attachment, which is displayed on the invoice." }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The description of the attachment, which is displayed on the invoice.\nThis field maps to the seller-defined **Message** field." }, "filesize": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The file size of the attachment in bytes." }, "hash": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The MD5 hash that was generated from the file contents." }, "mime_type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The mime type of the attachment.\nThe following mime types are supported: \nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf." }, "uploaded_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp when the attachment was uploaded, in RFC 3339 format." } }, "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints." }, "creator_team_member_id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the [team member](entity:TeamMember) who created the invoice.\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member." } }, "inner_properties": null, "description": "Stores information about an invoice. You use the Invoices API to create and manage\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview)." }, "idempotency_key": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A unique string that identifies the `UpdateInvoice` request. If you do not\nprovide `idempotency_key` (or provide an empty string as the value), the endpoint\ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." }, "fields_to_clear": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "The list of fields to clear. Although this field is currently supported, we\nrecommend using null values or the `remove` field when possible. For examples, see\n[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices)." } }, "inner_properties": null, "description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details." }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Describes a `UpdateInvoice` request.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"invoice\"\n ],\n \"properties\": {\n \"invoice\": {\n \"type\": \"object\",\n \"description\": \"Stores information about an invoice. You use the Invoices API to create and manage\\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The Square-assigned ID of the invoice.\",\n \"readOnly\": true\n },\n \"version\": {\n \"type\": \"integer\",\n \"description\": \"The Square-assigned version number, which is incremented each time an update is committed to the invoice.\"\n },\n \"location_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the location that this invoice is associated with. \\n\\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [order](entity:Order) for which the invoice is created. \\nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\\n\\nTo view the line items and other information for the associated order, call the \\n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID.\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"primary_recipient\": {\n \"type\": \"object\",\n \"description\": \"Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \\nand that Square uses to deliver the invoice.\\n\\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \\nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \\nSquare updates the customer ID in response to a merge operation, but does not update other fields.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"customer_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the customer. This is the customer profile ID that \\nyou provide when creating a draft invoice.\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"given_name\": {\n \"type\": \"string\",\n \"description\": \"The recipient's given (that is, first) name.\",\n \"readOnly\": true\n },\n \"family_name\": {\n \"type\": \"string\",\n \"description\": \"The recipient's family (that is, last) name.\",\n \"readOnly\": true\n },\n \"email_address\": {\n \"type\": \"string\",\n \"description\": \"The recipient's email address.\",\n \"readOnly\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Represents a postal address in a country. \\nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"address_line_1\": {\n \"type\": \"string\",\n \"description\": \"The first line of the address.\\n\\nFields that start with `address_line` provide the address's most specific\\ndetails, like street number, street name, and building name. They do *not*\\nprovide less specific details like city, state/province, or country (these\\ndetails are provided in other fields).\",\n \"nullable\": true\n },\n \"address_line_2\": {\n \"type\": \"string\",\n \"description\": \"The second line of the address, if any.\",\n \"nullable\": true\n },\n \"address_line_3\": {\n \"type\": \"string\",\n \"description\": \"The third line of the address, if any.\",\n \"nullable\": true\n },\n \"locality\": {\n \"type\": \"string\",\n \"description\": \"The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"sublocality\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `locality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_2\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_3\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality_2`, if any.\",\n \"nullable\": true\n },\n \"administrative_district_level_1\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's country. In the US, this\\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"administrative_district_level_2\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_1`.\\nIn the US, this is the county.\",\n \"nullable\": true\n },\n \"administrative_district_level_3\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_2`,\\nif any.\",\n \"nullable\": true\n },\n \"postal_code\": {\n \"type\": \"string\",\n \"description\": \"The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"country\": {\n \"type\": \"string\",\n \"enum\": [\n \"ZZ\",\n \"AD\",\n \"AE\",\n \"AF\",\n \"AG\",\n \"AI\",\n \"AL\",\n \"AM\",\n \"AO\",\n \"AQ\",\n \"AR\",\n \"AS\",\n \"AT\",\n \"AU\",\n \"AW\",\n \"AX\",\n \"AZ\",\n \"BA\",\n \"BB\",\n \"BD\",\n \"BE\",\n \"BF\",\n \"BG\",\n \"BH\",\n \"BI\",\n \"BJ\",\n \"BL\",\n \"BM\",\n \"BN\",\n \"BO\",\n \"BQ\",\n \"BR\",\n \"BS\",\n \"BT\",\n \"BV\",\n \"BW\",\n \"BY\",\n \"BZ\",\n \"CA\",\n \"CC\",\n \"CD\",\n \"CF\",\n \"CG\",\n \"CH\",\n \"CI\",\n \"CK\",\n \"CL\",\n \"CM\",\n \"CN\",\n \"CO\",\n \"CR\",\n \"CU\",\n \"CV\",\n \"CW\",\n \"CX\",\n \"CY\",\n \"CZ\",\n \"DE\",\n \"DJ\",\n \"DK\",\n \"DM\",\n \"DO\",\n \"DZ\",\n \"EC\",\n \"EE\",\n \"EG\",\n \"EH\",\n \"ER\",\n \"ES\",\n \"ET\",\n \"FI\",\n \"FJ\",\n \"FK\",\n \"FM\",\n \"FO\",\n \"FR\",\n \"GA\",\n \"GB\",\n \"GD\",\n \"GE\",\n \"GF\",\n \"GG\",\n \"GH\",\n \"GI\",\n \"GL\",\n \"GM\",\n \"GN\",\n \"GP\",\n \"GQ\",\n \"GR\",\n \"GS\",\n \"GT\",\n \"GU\",\n \"GW\",\n \"GY\",\n \"HK\",\n \"HM\",\n \"HN\",\n \"HR\",\n \"HT\",\n \"HU\",\n \"ID\",\n \"IE\",\n \"IL\",\n \"IM\",\n \"IN\",\n \"IO\",\n \"IQ\",\n \"IR\",\n \"IS\",\n \"IT\",\n \"JE\",\n \"JM\",\n \"JO\",\n \"JP\",\n \"KE\",\n \"KG\",\n \"KH\",\n \"KI\",\n \"KM\",\n \"KN\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KY\",\n \"KZ\",\n \"LA\",\n \"LB\",\n \"LC\",\n \"LI\",\n \"LK\",\n \"LR\",\n \"LS\",\n \"LT\",\n \"LU\",\n \"LV\",\n \"LY\",\n \"MA\",\n \"MC\",\n \"MD\",\n \"ME\",\n \"MF\",\n \"MG\",\n \"MH\",\n \"MK\",\n \"ML\",\n \"MM\",\n \"MN\",\n \"MO\",\n \"MP\",\n \"MQ\",\n \"MR\",\n \"MS\",\n \"MT\",\n \"MU\",\n \"MV\",\n \"MW\",\n \"MX\",\n \"MY\",\n \"MZ\",\n \"NA\",\n \"NC\",\n \"NE\",\n \"NF\",\n \"NG\",\n \"NI\",\n \"NL\",\n \"NO\",\n \"NP\",\n \"NR\",\n \"NU\",\n \"NZ\",\n \"OM\",\n \"PA\",\n \"PE\",\n \"PF\",\n \"PG\",\n \"PH\",\n \"PK\",\n \"PL\",\n \"PM\",\n \"PN\",\n \"PR\",\n \"PS\",\n \"PT\",\n \"PW\",\n \"PY\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RS\",\n \"RU\",\n \"RW\",\n \"SA\",\n \"SB\",\n \"SC\",\n \"SD\",\n \"SE\",\n \"SG\",\n \"SH\",\n \"SI\",\n \"SJ\",\n \"SK\",\n \"SL\",\n \"SM\",\n \"SN\",\n \"SO\",\n \"SR\",\n \"SS\",\n \"ST\",\n \"SV\",\n \"SX\",\n \"SY\",\n \"SZ\",\n \"TC\",\n \"TD\",\n \"TF\",\n \"TG\",\n \"TH\",\n \"TJ\",\n \"TK\",\n \"TL\",\n \"TM\",\n \"TN\",\n \"TO\",\n \"TR\",\n \"TT\",\n \"TV\",\n \"TW\",\n \"TZ\",\n \"UA\",\n \"UG\",\n \"UM\",\n \"US\",\n \"UY\",\n \"UZ\",\n \"VA\",\n \"VC\",\n \"VE\",\n \"VG\",\n \"VI\",\n \"VN\",\n \"VU\",\n \"WF\",\n \"WS\",\n \"YE\",\n \"YT\",\n \"ZA\",\n \"ZM\",\n \"ZW\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ZZ\",\n \"description\": \"Unknown\"\n },\n {\n \"name\": \"AD\",\n \"description\": \"Andorra\"\n },\n {\n \"name\": \"AE\",\n \"description\": \"United Arab Emirates\"\n },\n {\n \"name\": \"AF\",\n \"description\": \"Afghanistan\"\n },\n {\n \"name\": \"AG\",\n \"description\": \"Antigua and Barbuda\"\n },\n {\n \"name\": \"AI\",\n \"description\": \"Anguilla\"\n },\n {\n \"name\": \"AL\",\n \"description\": \"Albania\"\n },\n {\n \"name\": \"AM\",\n \"description\": \"Armenia\"\n },\n {\n \"name\": \"AO\",\n \"description\": \"Angola\"\n },\n {\n \"name\": \"AQ\",\n \"description\": \"Antartica\"\n },\n {\n \"name\": \"AR\",\n \"description\": \"Argentina\"\n },\n {\n \"name\": \"AS\",\n \"description\": \"American Samoa\"\n },\n {\n \"name\": \"AT\",\n \"description\": \"Austria\"\n },\n {\n \"name\": \"AU\",\n \"description\": \"Australia\"\n },\n {\n \"name\": \"AW\",\n \"description\": \"Aruba\"\n },\n {\n \"name\": \"AX\",\n \"description\": \"\\u00c5land Islands\"\n },\n {\n \"name\": \"AZ\",\n \"description\": \"Azerbaijan\"\n },\n {\n \"name\": \"BA\",\n \"description\": \"Bosnia and Herzegovina\"\n },\n {\n \"name\": \"BB\",\n \"description\": \"Barbados\"\n },\n {\n \"name\": \"BD\",\n \"description\": \"Bangladesh\"\n },\n {\n \"name\": \"BE\",\n \"description\": \"Belgium\"\n },\n {\n \"name\": \"BF\",\n \"description\": \"Burkina Faso\"\n },\n {\n \"name\": \"BG\",\n \"description\": \"Bulgaria\"\n },\n {\n \"name\": \"BH\",\n \"description\": \"Bahrain\"\n },\n {\n \"name\": \"BI\",\n \"description\": \"Burundi\"\n },\n {\n \"name\": \"BJ\",\n \"description\": \"Benin\"\n },\n {\n \"name\": \"BL\",\n \"description\": \"Saint Barth\\u00e9lemy\"\n },\n {\n \"name\": \"BM\",\n \"description\": \"Bermuda\"\n },\n {\n \"name\": \"BN\",\n \"description\": \"Brunei\"\n },\n {\n \"name\": \"BO\",\n \"description\": \"Bolivia\"\n },\n {\n \"name\": \"BQ\",\n \"description\": \"Bonaire\"\n },\n {\n \"name\": \"BR\",\n \"description\": \"Brazil\"\n },\n {\n \"name\": \"BS\",\n \"description\": \"Bahamas\"\n },\n {\n \"name\": \"BT\",\n \"description\": \"Bhutan\"\n },\n {\n \"name\": \"BV\",\n \"description\": \"Bouvet Island\"\n },\n {\n \"name\": \"BW\",\n \"description\": \"Botswana\"\n },\n {\n \"name\": \"BY\",\n \"description\": \"Belarus\"\n },\n {\n \"name\": \"BZ\",\n \"description\": \"Belize\"\n },\n {\n \"name\": \"CA\",\n \"description\": \"Canada\"\n },\n {\n \"name\": \"CC\",\n \"description\": \"Cocos Islands\"\n },\n {\n \"name\": \"CD\",\n \"description\": \"Democratic Republic of the Congo\"\n },\n {\n \"name\": \"CF\",\n \"description\": \"Central African Republic\"\n },\n {\n \"name\": \"CG\",\n \"description\": \"Congo\"\n },\n {\n \"name\": \"CH\",\n \"description\": \"Switzerland\"\n },\n {\n \"name\": \"CI\",\n \"description\": \"Ivory Coast\"\n },\n {\n \"name\": \"CK\",\n \"description\": \"Cook Islands\"\n },\n {\n \"name\": \"CL\",\n \"description\": \"Chile\"\n },\n {\n \"name\": \"CM\",\n \"description\": \"Cameroon\"\n },\n {\n \"name\": \"CN\",\n \"description\": \"China\"\n },\n {\n \"name\": \"CO\",\n \"description\": \"Colombia\"\n },\n {\n \"name\": \"CR\",\n \"description\": \"Costa Rica\"\n },\n {\n \"name\": \"CU\",\n \"description\": \"Cuba\"\n },\n {\n \"name\": \"CV\",\n \"description\": \"Cabo Verde\"\n },\n {\n \"name\": \"CW\",\n \"description\": \"Cura\\u00e7ao\"\n },\n {\n \"name\": \"CX\",\n \"description\": \"Christmas Island\"\n },\n {\n \"name\": \"CY\",\n \"description\": \"Cyprus\"\n },\n {\n \"name\": \"CZ\",\n \"description\": \"Czechia\"\n },\n {\n \"name\": \"DE\",\n \"description\": \"Germany\"\n },\n {\n \"name\": \"DJ\",\n \"description\": \"Djibouti\"\n },\n {\n \"name\": \"DK\",\n \"description\": \"Denmark\"\n },\n {\n \"name\": \"DM\",\n \"description\": \"Dominica\"\n },\n {\n \"name\": \"DO\",\n \"description\": \"Dominican Republic\"\n },\n {\n \"name\": \"DZ\",\n \"description\": \"Algeria\"\n },\n {\n \"name\": \"EC\",\n \"description\": \"Ecuador\"\n },\n {\n \"name\": \"EE\",\n \"description\": \"Estonia\"\n },\n {\n \"name\": \"EG\",\n \"description\": \"Egypt\"\n },\n {\n \"name\": \"EH\",\n \"description\": \"Western Sahara\"\n },\n {\n \"name\": \"ER\",\n \"description\": \"Eritrea\"\n },\n {\n \"name\": \"ES\",\n \"description\": \"Spain\"\n },\n {\n \"name\": \"ET\",\n \"description\": \"Ethiopia\"\n },\n {\n \"name\": \"FI\",\n \"description\": \"Finland\"\n },\n {\n \"name\": \"FJ\",\n \"description\": \"Fiji\"\n },\n {\n \"name\": \"FK\",\n \"description\": \"Falkland Islands\"\n },\n {\n \"name\": \"FM\",\n \"description\": \"Federated States of Micronesia\"\n },\n {\n \"name\": \"FO\",\n \"description\": \"Faroe Islands\"\n },\n {\n \"name\": \"FR\",\n \"description\": \"France\"\n },\n {\n \"name\": \"GA\",\n \"description\": \"Gabon\"\n },\n {\n \"name\": \"GB\",\n \"description\": \"United Kingdom\"\n },\n {\n \"name\": \"GD\",\n \"description\": \"Grenada\"\n },\n {\n \"name\": \"GE\",\n \"description\": \"Georgia\"\n },\n {\n \"name\": \"GF\",\n \"description\": \"French Guiana\"\n },\n {\n \"name\": \"GG\",\n \"description\": \"Guernsey\"\n },\n {\n \"name\": \"GH\",\n \"description\": \"Ghana\"\n },\n {\n \"name\": \"GI\",\n \"description\": \"Gibraltar\"\n },\n {\n \"name\": \"GL\",\n \"description\": \"Greenland\"\n },\n {\n \"name\": \"GM\",\n \"description\": \"Gambia\"\n },\n {\n \"name\": \"GN\",\n \"description\": \"Guinea\"\n },\n {\n \"name\": \"GP\",\n \"description\": \"Guadeloupe\"\n },\n {\n \"name\": \"GQ\",\n \"description\": \"Equatorial Guinea\"\n },\n {\n \"name\": \"GR\",\n \"description\": \"Greece\"\n },\n {\n \"name\": \"GS\",\n \"description\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"name\": \"GT\",\n \"description\": \"Guatemala\"\n },\n {\n \"name\": \"GU\",\n \"description\": \"Guam\"\n },\n {\n \"name\": \"GW\",\n \"description\": \"Guinea-Bissau\"\n },\n {\n \"name\": \"GY\",\n \"description\": \"Guyana\"\n },\n {\n \"name\": \"HK\",\n \"description\": \"Hong Kong\"\n },\n {\n \"name\": \"HM\",\n \"description\": \"Heard Island and McDonald Islands\"\n },\n {\n \"name\": \"HN\",\n \"description\": \"Honduras\"\n },\n {\n \"name\": \"HR\",\n \"description\": \"Croatia\"\n },\n {\n \"name\": \"HT\",\n \"description\": \"Haiti\"\n },\n {\n \"name\": \"HU\",\n \"description\": \"Hungary\"\n },\n {\n \"name\": \"ID\",\n \"description\": \"Indonesia\"\n },\n {\n \"name\": \"IE\",\n \"description\": \"Ireland\"\n },\n {\n \"name\": \"IL\",\n \"description\": \"Israel\"\n },\n {\n \"name\": \"IM\",\n \"description\": \"Isle of Man\"\n },\n {\n \"name\": \"IN\",\n \"description\": \"India\"\n },\n {\n \"name\": \"IO\",\n \"description\": \"British Indian Ocean Territory\"\n },\n {\n \"name\": \"IQ\",\n \"description\": \"Iraq\"\n },\n {\n \"name\": \"IR\",\n \"description\": \"Iran\"\n },\n {\n \"name\": \"IS\",\n \"description\": \"Iceland\"\n },\n {\n \"name\": \"IT\",\n \"description\": \"Italy\"\n },\n {\n \"name\": \"JE\",\n \"description\": \"Jersey\"\n },\n {\n \"name\": \"JM\",\n \"description\": \"Jamaica\"\n },\n {\n \"name\": \"JO\",\n \"description\": \"Jordan\"\n },\n {\n \"name\": \"JP\",\n \"description\": \"Japan\"\n },\n {\n \"name\": \"KE\",\n \"description\": \"Kenya\"\n },\n {\n \"name\": \"KG\",\n \"description\": \"Kyrgyzstan\"\n },\n {\n \"name\": \"KH\",\n \"description\": \"Cambodia\"\n },\n {\n \"name\": \"KI\",\n \"description\": \"Kiribati\"\n },\n {\n \"name\": \"KM\",\n \"description\": \"Comoros\"\n },\n {\n \"name\": \"KN\",\n \"description\": \"Saint Kitts and Nevis\"\n },\n {\n \"name\": \"KP\",\n \"description\": \"Democratic People's Republic of Korea\"\n },\n {\n \"name\": \"KR\",\n \"description\": \"Republic of Korea\"\n },\n {\n \"name\": \"KW\",\n \"description\": \"Kuwait\"\n },\n {\n \"name\": \"KY\",\n \"description\": \"Cayman Islands\"\n },\n {\n \"name\": \"KZ\",\n \"description\": \"Kazakhstan\"\n },\n {\n \"name\": \"LA\",\n \"description\": \"Lao People's Democratic Republic\"\n },\n {\n \"name\": \"LB\",\n \"description\": \"Lebanon\"\n },\n {\n \"name\": \"LC\",\n \"description\": \"Saint Lucia\"\n },\n {\n \"name\": \"LI\",\n \"description\": \"Liechtenstein\"\n },\n {\n \"name\": \"LK\",\n \"description\": \"Sri Lanka\"\n },\n {\n \"name\": \"LR\",\n \"description\": \"Liberia\"\n },\n {\n \"name\": \"LS\",\n \"description\": \"Lesotho\"\n },\n {\n \"name\": \"LT\",\n \"description\": \"Lithuania\"\n },\n {\n \"name\": \"LU\",\n \"description\": \"Luxembourg\"\n },\n {\n \"name\": \"LV\",\n \"description\": \"Latvia\"\n },\n {\n \"name\": \"LY\",\n \"description\": \"Libya\"\n },\n {\n \"name\": \"MA\",\n \"description\": \"Morocco\"\n },\n {\n \"name\": \"MC\",\n \"description\": \"Monaco\"\n },\n {\n \"name\": \"MD\",\n \"description\": \"Moldova\"\n },\n {\n \"name\": \"ME\",\n \"description\": \"Montenegro\"\n },\n {\n \"name\": \"MF\",\n \"description\": \"Saint Martin\"\n },\n {\n \"name\": \"MG\",\n \"description\": \"Madagascar\"\n },\n {\n \"name\": \"MH\",\n \"description\": \"Marshall Islands\"\n },\n {\n \"name\": \"MK\",\n \"description\": \"North Macedonia\"\n },\n {\n \"name\": \"ML\",\n \"description\": \"Mali\"\n },\n {\n \"name\": \"MM\",\n \"description\": \"Myanmar\"\n },\n {\n \"name\": \"MN\",\n \"description\": \"Mongolia\"\n },\n {\n \"name\": \"MO\",\n \"description\": \"Macao\"\n },\n {\n \"name\": \"MP\",\n \"description\": \"Northern Mariana Islands\"\n },\n {\n \"name\": \"MQ\",\n \"description\": \"Martinique\"\n },\n {\n \"name\": \"MR\",\n \"description\": \"Mauritania\"\n },\n {\n \"name\": \"MS\",\n \"description\": \"Montserrat\"\n },\n {\n \"name\": \"MT\",\n \"description\": \"Malta\"\n },\n {\n \"name\": \"MU\",\n \"description\": \"Mauritius\"\n },\n {\n \"name\": \"MV\",\n \"description\": \"Maldives\"\n },\n {\n \"name\": \"MW\",\n \"description\": \"Malawi\"\n },\n {\n \"name\": \"MX\",\n \"description\": \"Mexico\"\n },\n {\n \"name\": \"MY\",\n \"description\": \"Malaysia\"\n },\n {\n \"name\": \"MZ\",\n \"description\": \"Mozambique\"\n },\n {\n \"name\": \"NA\",\n \"description\": \"Namibia\"\n },\n {\n \"name\": \"NC\",\n \"description\": \"New Caledonia\"\n },\n {\n \"name\": \"NE\",\n \"description\": \"Niger\"\n },\n {\n \"name\": \"NF\",\n \"description\": \"Norfolk Island\"\n },\n {\n \"name\": \"NG\",\n \"description\": \"Nigeria\"\n },\n {\n \"name\": \"NI\",\n \"description\": \"Nicaragua\"\n },\n {\n \"name\": \"NL\",\n \"description\": \"Netherlands\"\n },\n {\n \"name\": \"NO\",\n \"description\": \"Norway\"\n },\n {\n \"name\": \"NP\",\n \"description\": \"Nepal\"\n },\n {\n \"name\": \"NR\",\n \"description\": \"Nauru\"\n },\n {\n \"name\": \"NU\",\n \"description\": \"Niue\"\n },\n {\n \"name\": \"NZ\",\n \"description\": \"New Zealand\"\n },\n {\n \"name\": \"OM\",\n \"description\": \"Oman\"\n },\n {\n \"name\": \"PA\",\n \"description\": \"Panama\"\n },\n {\n \"name\": \"PE\",\n \"description\": \"Peru\"\n },\n {\n \"name\": \"PF\",\n \"description\": \"French Polynesia\"\n },\n {\n \"name\": \"PG\",\n \"description\": \"Papua New Guinea\"\n },\n {\n \"name\": \"PH\",\n \"description\": \"Philippines\"\n },\n {\n \"name\": \"PK\",\n \"description\": \"Pakistan\"\n },\n {\n \"name\": \"PL\",\n \"description\": \"Poland\"\n },\n {\n \"name\": \"PM\",\n \"description\": \"Saint Pierre and Miquelon\"\n },\n {\n \"name\": \"PN\",\n \"description\": \"Pitcairn\"\n },\n {\n \"name\": \"PR\",\n \"description\": \"Puerto Rico\"\n },\n {\n \"name\": \"PS\",\n \"description\": \"Palestine\"\n },\n {\n \"name\": \"PT\",\n \"description\": \"Portugal\"\n },\n {\n \"name\": \"PW\",\n \"description\": \"Palau\"\n },\n {\n \"name\": \"PY\",\n \"description\": \"Paraguay\"\n },\n {\n \"name\": \"QA\",\n \"description\": \"Qatar\"\n },\n {\n \"name\": \"RE\",\n \"description\": \"R\\u00e9union\"\n },\n {\n \"name\": \"RO\",\n \"description\": \"Romania\"\n },\n {\n \"name\": \"RS\",\n \"description\": \"Serbia\"\n },\n {\n \"name\": \"RU\",\n \"description\": \"Russia\"\n },\n {\n \"name\": \"RW\",\n \"description\": \"Rwanda\"\n },\n {\n \"name\": \"SA\",\n \"description\": \"Saudi Arabia\"\n },\n {\n \"name\": \"SB\",\n \"description\": \"Solomon Islands\"\n },\n {\n \"name\": \"SC\",\n \"description\": \"Seychelles\"\n },\n {\n \"name\": \"SD\",\n \"description\": \"Sudan\"\n },\n {\n \"name\": \"SE\",\n \"description\": \"Sweden\"\n },\n {\n \"name\": \"SG\",\n \"description\": \"Singapore\"\n },\n {\n \"name\": \"SH\",\n \"description\": \"Saint Helena, Ascension and Tristan da Cunha\"\n },\n {\n \"name\": \"SI\",\n \"description\": \"Slovenia\"\n },\n {\n \"name\": \"SJ\",\n \"description\": \"Svalbard and Jan Mayen\"\n },\n {\n \"name\": \"SK\",\n \"description\": \"Slovakia\"\n },\n {\n \"name\": \"SL\",\n \"description\": \"Sierra Leone\"\n },\n {\n \"name\": \"SM\",\n \"description\": \"San Marino\"\n },\n {\n \"name\": \"SN\",\n \"description\": \"Senegal\"\n },\n {\n \"name\": \"SO\",\n \"description\": \"Somalia\"\n },\n {\n \"name\": \"SR\",\n \"description\": \"Suriname\"\n },\n {\n \"name\": \"SS\",\n \"description\": \"South Sudan\"\n },\n {\n \"name\": \"ST\",\n \"description\": \"Sao Tome and Principe\"\n },\n {\n \"name\": \"SV\",\n \"description\": \"El Salvador\"\n },\n {\n \"name\": \"SX\",\n \"description\": \"Sint Maarten\"\n },\n {\n \"name\": \"SY\",\n \"description\": \"Syrian Arab Republic\"\n },\n {\n \"name\": \"SZ\",\n \"description\": \"Eswatini\"\n },\n {\n \"name\": \"TC\",\n \"description\": \"Turks and Caicos Islands\"\n },\n {\n \"name\": \"TD\",\n \"description\": \"Chad\"\n },\n {\n \"name\": \"TF\",\n \"description\": \"French Southern Territories\"\n },\n {\n \"name\": \"TG\",\n \"description\": \"Togo\"\n },\n {\n \"name\": \"TH\",\n \"description\": \"Thailand\"\n },\n {\n \"name\": \"TJ\",\n \"description\": \"Tajikistan\"\n },\n {\n \"name\": \"TK\",\n \"description\": \"Tokelau\"\n },\n {\n \"name\": \"TL\",\n \"description\": \"Timor-Leste\"\n },\n {\n \"name\": \"TM\",\n \"description\": \"Turkmenistan\"\n },\n {\n \"name\": \"TN\",\n \"description\": \"Tunisia\"\n },\n {\n \"name\": \"TO\",\n \"description\": \"Tonga\"\n },\n {\n \"name\": \"TR\",\n \"description\": \"Turkey\"\n },\n {\n \"name\": \"TT\",\n \"description\": \"Trinidad and Tobago\"\n },\n {\n \"name\": \"TV\",\n \"description\": \"Tuvalu\"\n },\n {\n \"name\": \"TW\",\n \"description\": \"Taiwan\"\n },\n {\n \"name\": \"TZ\",\n \"description\": \"Tanzania\"\n },\n {\n \"name\": \"UA\",\n \"description\": \"Ukraine\"\n },\n {\n \"name\": \"UG\",\n \"description\": \"Uganda\"\n },\n {\n \"name\": \"UM\",\n \"description\": \"United States Minor Outlying Islands\"\n },\n {\n \"name\": \"US\",\n \"description\": \"United States of America\"\n },\n {\n \"name\": \"UY\",\n \"description\": \"Uruguay\"\n },\n {\n \"name\": \"UZ\",\n \"description\": \"Uzbekistan\"\n },\n {\n \"name\": \"VA\",\n \"description\": \"Vatican City\"\n },\n {\n \"name\": \"VC\",\n \"description\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"name\": \"VE\",\n \"description\": \"Venezuela\"\n },\n {\n \"name\": \"VG\",\n \"description\": \"British Virgin Islands\"\n },\n {\n \"name\": \"VI\",\n \"description\": \"U.S. Virgin Islands\"\n },\n {\n \"name\": \"VN\",\n \"description\": \"Vietnam\"\n },\n {\n \"name\": \"VU\",\n \"description\": \"Vanuatu\"\n },\n {\n \"name\": \"WF\",\n \"description\": \"Wallis and Futuna\"\n },\n {\n \"name\": \"WS\",\n \"description\": \"Samoa\"\n },\n {\n \"name\": \"YE\",\n \"description\": \"Yemen\"\n },\n {\n \"name\": \"YT\",\n \"description\": \"Mayotte\"\n },\n {\n \"name\": \"ZA\",\n \"description\": \"South Africa\"\n },\n {\n \"name\": \"ZM\",\n \"description\": \"Zambia\"\n },\n {\n \"name\": \"ZW\",\n \"description\": \"Zimbabwe\"\n }\n ],\n \"description\": \"Indicates the country associated with another entity, such as a business.\\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"first_name\": {\n \"type\": \"string\",\n \"description\": \"Optional first name when it's representing recipient.\",\n \"nullable\": true\n },\n \"last_name\": {\n \"type\": \"string\",\n \"description\": \"Optional last name when it's representing recipient.\",\n \"nullable\": true\n }\n }\n },\n \"phone_number\": {\n \"type\": \"string\",\n \"description\": \"The recipient's phone number.\",\n \"readOnly\": true\n },\n \"company_name\": {\n \"type\": \"string\",\n \"description\": \"The name of the recipient's company.\",\n \"readOnly\": true\n },\n \"tax_ids\": {\n \"type\": \"object\",\n \"description\": \"Represents the tax IDs for an invoice recipient. The country of the seller account determines \\nwhether the corresponding `tax_ids` field is available for the customer. For more information, \\nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"eu_vat\": {\n \"type\": \"string\",\n \"description\": \"The EU VAT identification number for the invoice recipient. For example, `IE3426675K`.\",\n \"readOnly\": true\n }\n }\n }\n }\n },\n \"payment_requests\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum\\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \\nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\\n\\nAdding `INSTALLMENT` payment requests to an invoice requires an \\n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"uid\": {\n \"type\": \"string\",\n \"description\": \"The Square-generated ID of the payment request in an [invoice](entity:Invoice).\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"request_method\": {\n \"type\": \"string\",\n \"enum\": [\n \"EMAIL\",\n \"CHARGE_CARD_ON_FILE\",\n \"SHARE_MANUALLY\",\n \"CHARGE_BANK_ON_FILE\",\n \"SMS\",\n \"SMS_CHARGE_CARD_ON_FILE\",\n \"SMS_CHARGE_BANK_ON_FILE\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"EMAIL\",\n \"description\": \"Directs Square to send invoices, reminders, and receipts to the customer using email.\\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\\ntime, if specified in the [invoice](entity:Invoice)).\"\n },\n {\n \"name\": \"CHARGE_CARD_ON_FILE\",\n \"description\": \"Directs Square to charge the card on file on the `due_date` specified in the payment request\\nand to use email to send invoices, reminders, and receipts.\"\n },\n {\n \"name\": \"SHARE_MANUALLY\",\n \"description\": \"Directs Square to take no specific action on the invoice. In this case, the seller \\n(or the application developer) follows up with the customer for payment. For example, \\na seller might collect a payment in the Seller Dashboard or use the Point of Sale (POS) application. \\nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer requesting payment.\"\n },\n {\n \"name\": \"CHARGE_BANK_ON_FILE\",\n \"description\": \"Directs Square to charge the customer's bank account on file and to use email to send invoices, reminders, and receipts.\\nThe customer must approve the payment.\\n\\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard or other\\nSquare product. The bank account is provided by the customer during the payment flow. You \\ncannot set `CHARGE_BANK_ON_FILE` as a request method using the Invoices API.\"\n },\n {\n \"name\": \"SMS\",\n \"description\": \"Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](entity:Invoice)). \\n\\nYou cannot set `SMS` as a request method using the Invoices API.\"\n },\n {\n \"name\": \"SMS_CHARGE_CARD_ON_FILE\",\n \"description\": \"Directs Square to charge the card on file on the `due_date` specified in the payment request and to\\nuse SMS (text message) to send invoices and receipts. \\n\\nYou cannot set `SMS_CHARGE_CARD_ON_FILE` as a request method using the Invoices API.\"\n },\n {\n \"name\": \"SMS_CHARGE_BANK_ON_FILE\",\n \"description\": \"Directs Square to charge the customer's bank account on file and to use SMS (text message) to send invoices and receipts.\\nThe customer must approve the payment.\\n\\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard\\nor other Square product. The bank account is provided by the customer during the payment flow. \\nYou cannot set `SMS_CHARGE_BANK_ON_FILE` as a request method using the Invoices API.\"\n }\n ],\n \"description\": \"Specifies the action for Square to take for processing the invoice. For example, \\nemail the invoice, charge a customer's card on file, or do nothing. DEPRECATED at\\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.\",\n \"x-release-status\": \"DEPRECATED\"\n },\n \"request_type\": {\n \"type\": \"string\",\n \"enum\": [\n \"BALANCE\",\n \"DEPOSIT\",\n \"INSTALLMENT\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"BALANCE\",\n \"description\": \"A request for a balance payment. The balance amount is computed as follows: \\n\\n- If the invoice specifies only a balance payment request, the balance amount is the \\ntotal amount of the associated order. \\n- If the invoice also specifies a deposit request, the balance amount is the amount \\nremaining after the deposit.\\n\\n`INSTALLMENT` and `BALANCE` payment requests are not allowed in the same invoice.\"\n },\n {\n \"name\": \"DEPOSIT\",\n \"description\": \"A request for a deposit payment. You have the option of specifying \\nan exact amount or a percentage of the total order amount. If you request a deposit, \\nit must be due before any other payment requests.\"\n },\n {\n \"name\": \"INSTALLMENT\",\n \"description\": \"A request for an installment payment. Installments allow buyers to pay the invoice over time. Installments can optionally be combined with a deposit. \\n\\nAdding `INSTALLMENT` payment requests to an invoice requires an \\n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\"\n }\n ],\n \"description\": \"Indicates the type of the payment request. For more information, see \\n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"due_date\": {\n \"type\": \"string\",\n \"description\": \"The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field\\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\\ncharges the payment source on this date.\\n\\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\\nof America/Los\\\\_Angeles becomes overdue at midnight on March 9 in America/Los\\\\_Angeles (which equals a UTC\\ntimestamp of 2021-03-10T08:00:00Z).\",\n \"nullable\": true\n },\n \"fixed_amount_requested_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"percentage_requested\": {\n \"type\": \"string\",\n \"description\": \"Specifies the amount for the payment request in percentage:\\n\\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount.\\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less \\nthe deposit, if requested. The sum of the `percentage_requested` in all installment \\npayment requests must be equal to 100.\\n\\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \\npayment request specifies the `fixed_amount_requested_money` field.\",\n \"nullable\": true\n },\n \"tipping_enabled\": {\n \"type\": \"boolean\",\n \"description\": \"If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \\nprovides a place for the customer to pay a tip. \\n\\nThis field is allowed only on the final payment request \\nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`.\",\n \"nullable\": true\n },\n \"automatic_payment_source\": {\n \"type\": \"string\",\n \"enum\": [\n \"NONE\",\n \"CARD_ON_FILE\",\n \"BANK_ON_FILE\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"NONE\",\n \"description\": \"An automatic payment is not configured for the payment request.\"\n },\n {\n \"name\": \"CARD_ON_FILE\",\n \"description\": \"Use a card on file as the automatic payment method. On the due date, Square charges the card\\nfor the amount of the payment request.\\n\\nFor `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be\\nspecified for the payment request before the invoice can be published.\"\n },\n {\n \"name\": \"BANK_ON_FILE\",\n \"description\": \"Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\\nrequest to approve the payment when the invoice is sent or the invoice is updated.\\n\\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\\nSquare product. The bank account is provided by the customer during the payment flow. \\n\\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`.\"\n }\n ],\n \"description\": \"Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"card_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"reminders\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Describes a payment request reminder (automatic notification) that Square sends\\nto the customer. You configure a reminder relative to the payment request\\n`due_date`.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"uid\": {\n \"type\": \"string\",\n \"description\": \"A Square-assigned ID that uniquely identifies the reminder within the\\n`InvoicePaymentRequest`.\",\n \"readOnly\": true\n },\n \"relative_scheduled_days\": {\n \"type\": \"integer\",\n \"description\": \"The number of days before (a negative number) or after (a positive number)\\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\\nthe reminder should be sent 3 days before the payment request `due_date`.\",\n \"minimum\": -32767,\n \"maximum\": 32767,\n \"nullable\": true\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"The reminder message.\",\n \"minLength\": 1,\n \"maxLength\": 1000,\n \"nullable\": true\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"PENDING\",\n \"NOT_APPLICABLE\",\n \"SENT\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"PENDING\",\n \"description\": \"The reminder will be sent on the `relative_scheduled_date` (if the invoice is published).\"\n },\n {\n \"name\": \"NOT_APPLICABLE\",\n \"description\": \"The reminder is not applicable and is not sent. The following are examples\\nof when reminders are not applicable and are not sent:\\n- You schedule a reminder to be sent before the invoice is published.\\n- The invoice is configured with multiple payment requests and a payment request reminder\\nis configured to be sent after the next payment request `due_date`.\\n- Two reminders (for different payment requests) are configured to be sent on the\\nsame date. Therefore, only one reminder is sent.\\n- You configure a reminder to be sent on the date that the invoice is scheduled to be sent.\\n- The payment request is already paid.\\n- The invoice status is `CANCELED` or `FAILED`.\"\n },\n {\n \"name\": \"SENT\",\n \"description\": \"The reminder is sent.\"\n }\n ],\n \"description\": \"The status of a payment request reminder.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"sent_at\": {\n \"type\": \"string\",\n \"description\": \"If sent, the timestamp when the reminder was sent, in RFC 3339 format.\",\n \"readOnly\": true\n }\n }\n },\n \"description\": \"A list of one or more reminders to send for the payment request.\",\n \"nullable\": true\n },\n \"computed_amount_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"total_completed_amount_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"rounding_adjustment_included_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n }\n }\n },\n \"description\": \"The payment schedule for the invoice, represented by one or more payment requests that\\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\\n- One balance\\n- One deposit with one balance\\n- 2\\u201312 installments \\n- One deposit with 2\\u201312 installments\\n\\nThis field is required when creating an invoice. It must contain at least one payment request. \\nAll payment requests for the invoice must equal the total order amount. For more information, see \\n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\\n\\nAdding `INSTALLMENT` payment requests to an invoice requires an \\n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\",\n \"nullable\": true\n },\n \"delivery_method\": {\n \"type\": \"string\",\n \"enum\": [\n \"EMAIL\",\n \"SHARE_MANUALLY\",\n \"SMS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"EMAIL\",\n \"description\": \"Directs Square to send invoices, reminders, and receipts to the customer using email.\"\n },\n {\n \"name\": \"SHARE_MANUALLY\",\n \"description\": \"Directs Square to take no action on the invoice. In this case, the seller\\nor application developer follows up with the customer for payment. For example,\\na seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.\\nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment.\"\n },\n {\n \"name\": \"SMS\",\n \"description\": \"Directs Square to send invoices and receipts to the customer using SMS (text message).\\n\\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`.\"\n }\n ],\n \"description\": \"Indicates how Square delivers the [invoice](entity:Invoice) to the customer.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"invoice_number\": {\n \"type\": \"string\",\n \"description\": \"A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\\nIf not provided when creating an invoice, Square assigns a value.\\nIt increments from 1 and is padded with zeros making it 7 characters long\\n(for example, 0000001 and 0000002).\",\n \"minLength\": 1,\n \"maxLength\": 191,\n \"nullable\": true\n },\n \"title\": {\n \"type\": \"string\",\n \"description\": \"The title of the invoice, which is displayed on the invoice.\",\n \"minLength\": 1,\n \"maxLength\": 255,\n \"nullable\": true\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"The description of the invoice, which is displayed on the invoice.\",\n \"minLength\": 1,\n \"maxLength\": 65536,\n \"nullable\": true\n },\n \"scheduled_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\\nAfter the invoice is published, Square processes the invoice on the specified date,\\naccording to the delivery method and payment request settings.\\n\\nIf the field is not set, Square processes the invoice immediately after it is published.\",\n \"nullable\": true\n },\n \"public_url\": {\n \"type\": \"string\",\n \"description\": \"A temporary link to the Square-hosted payment page where the customer can pay the\\ninvoice. If the link expires, customers can provide the email address or phone number\\nassociated with the invoice and request a new link directly from the expired payment page. \\n\\nThis field is added after the invoice is published and reaches the scheduled date\\n(if one is defined).\",\n \"readOnly\": true\n },\n \"next_payment_amount_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"DRAFT\",\n \"UNPAID\",\n \"SCHEDULED\",\n \"PARTIALLY_PAID\",\n \"PAID\",\n \"PARTIALLY_REFUNDED\",\n \"REFUNDED\",\n \"CANCELED\",\n \"FAILED\",\n \"PAYMENT_PENDING\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"DRAFT\",\n \"description\": \"The invoice is a draft. You must publish a draft invoice before Square can process it.\\nA draft invoice has no `public_url`, so it is not available to customers.\"\n },\n {\n \"name\": \"UNPAID\",\n \"description\": \"The invoice is published but not yet paid.\"\n },\n {\n \"name\": \"SCHEDULED\",\n \"description\": \"The invoice is scheduled to be processed. On the scheduled date,\\nSquare sends the invoice, initiates an automatic payment, or takes no action, depending on\\nthe delivery method and payment request settings. Square also sets the invoice status to the\\nappropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`.\"\n },\n {\n \"name\": \"PARTIALLY_PAID\",\n \"description\": \"A partial payment is received for the invoice.\"\n },\n {\n \"name\": \"PAID\",\n \"description\": \"The customer paid the invoice in full.\"\n },\n {\n \"name\": \"PARTIALLY_REFUNDED\",\n \"description\": \"The invoice is paid (or partially paid) and some but not all the amount paid is\\nrefunded.\"\n },\n {\n \"name\": \"REFUNDED\",\n \"description\": \"The full amount that the customer paid for the invoice is refunded.\"\n },\n {\n \"name\": \"CANCELED\",\n \"description\": \"The invoice is canceled. Square no longer requests payments from the customer.\\nThe Square-hosted payment page is still accessible using the temporary `public_url`\\nlink, but the invoice is shown as canceled and does not accept payment.\"\n },\n {\n \"name\": \"FAILED\",\n \"description\": \"Square canceled the invoice due to suspicious activity.\"\n },\n {\n \"name\": \"PAYMENT_PENDING\",\n \"description\": \"A payment on the invoice was initiated but has not yet been processed.\\n\\nWhen in this state, invoices cannot be updated and other payments cannot be initiated.\"\n }\n ],\n \"description\": \"Indicates the status of an [invoice](entity:Invoice).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"timezone\": {\n \"type\": \"string\",\n \"description\": \"The time zone used to interpret calendar dates on the invoice, such as `due_date`.\\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\\nlocation. The value cannot be changed.\\n\\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\\\_Angeles\\nbecomes overdue at midnight on March 9 in America/Los\\\\_Angeles (which equals a UTC timestamp\\nof 2021-03-10T08:00:00Z).\",\n \"readOnly\": true\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the invoice was created, in RFC 3339 format.\",\n \"readOnly\": true\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the invoice was last updated, in RFC 3339 format.\",\n \"readOnly\": true\n },\n \"accepted_payment_methods\": {\n \"type\": \"object\",\n \"description\": \"The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"card\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether credit card or debit card payments are accepted. The default value is `false`.\",\n \"nullable\": true\n },\n \"square_gift_card\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether Square gift card payments are accepted. The default value is `false`.\",\n \"nullable\": true\n },\n \"bank_account\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether ACH bank transfer payments are accepted. The default value is `false`.\",\n \"nullable\": true\n },\n \"buy_now_pay_later\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\\n\\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later).\",\n \"nullable\": true\n },\n \"cash_app_pay\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether Cash App payments are accepted. The default value is `false`.\\n\\nThis payment method is supported only for seller [locations](entity:Location) in the United States.\",\n \"nullable\": true\n }\n }\n },\n \"custom_fields\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"An additional seller-defined and customer-facing field to include on the invoice. For more information, \\nsee [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\\n\\nAdding custom fields to an invoice requires an \\n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"label\": {\n \"type\": \"string\",\n \"description\": \"The label or title of the custom field. This field is required for a custom field.\",\n \"maxLength\": 30,\n \"nullable\": true\n },\n \"value\": {\n \"type\": \"string\",\n \"description\": \"The text of the custom field. If omitted, only the label is rendered.\",\n \"maxLength\": 2000,\n \"nullable\": true\n },\n \"placement\": {\n \"type\": \"string\",\n \"enum\": [\n \"ABOVE_LINE_ITEMS\",\n \"BELOW_LINE_ITEMS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ABOVE_LINE_ITEMS\",\n \"description\": \"Render the custom field above the invoice line items.\"\n },\n {\n \"name\": \"BELOW_LINE_ITEMS\",\n \"description\": \"Render the custom field below the invoice line items.\"\n }\n ],\n \"description\": \"Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \\ncopies of the invoice.\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"description\": \"Additional seller-defined fields that are displayed on the invoice. For more information, see\\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\\n\\nAdding custom fields to an invoice requires an \\n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\\n\\nMax: 2 custom fields\",\n \"nullable\": true\n },\n \"subscription_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [subscription](entity:Subscription) associated with the invoice.\\nThis field is present only on subscription billing invoices.\",\n \"readOnly\": true\n },\n \"sale_or_service_date\": {\n \"type\": \"string\",\n \"description\": \"The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\\nThis field can be used to specify a past or future date which is displayed on the invoice.\",\n \"nullable\": true\n },\n \"payment_conditions\": {\n \"type\": \"string\",\n \"description\": \"**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \\nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\\n\\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \\n\\\"Payment conditions are not supported for this location's country\\\" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.\",\n \"minLength\": 1,\n \"maxLength\": 2000,\n \"nullable\": true\n },\n \"store_payment_method_enabled\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`.\",\n \"nullable\": true\n },\n \"attachments\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents a file attached to an [invoice](entity:Invoice).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The Square-assigned ID of the attachment.\",\n \"readOnly\": true\n },\n \"filename\": {\n \"type\": \"string\",\n \"description\": \"The file name of the attachment, which is displayed on the invoice.\",\n \"readOnly\": true\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"The description of the attachment, which is displayed on the invoice.\\nThis field maps to the seller-defined **Message** field.\",\n \"readOnly\": true\n },\n \"filesize\": {\n \"type\": \"integer\",\n \"description\": \"The file size of the attachment in bytes.\",\n \"readOnly\": true\n },\n \"hash\": {\n \"type\": \"string\",\n \"description\": \"The MD5 hash that was generated from the file contents.\",\n \"readOnly\": true\n },\n \"mime_type\": {\n \"type\": \"string\",\n \"description\": \"The mime type of the attachment.\\nThe following mime types are supported: \\nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf.\",\n \"readOnly\": true\n },\n \"uploaded_at\": {\n \"type\": \"string\",\n \"description\": \"The timestamp when the attachment was uploaded, in RFC 3339 format.\",\n \"readOnly\": true\n }\n }\n },\n \"description\": \"Metadata about the attachments on the invoice. Invoice attachments are managed using the\\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints.\",\n \"readOnly\": true\n },\n \"creator_team_member_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [team member](entity:TeamMember) who created the invoice.\\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member.\",\n \"readOnly\": true\n }\n }\n },\n \"idempotency_key\": {\n \"type\": \"string\",\n \"description\": \"A unique string that identifies the `UpdateInvoice` request. If you do not\\nprovide `idempotency_key` (or provide an empty string as the value), the endpoint\\ntreats each request as independent.\\n\\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\",\n \"maxLength\": 128,\n \"nullable\": true\n },\n \"fields_to_clear\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The list of fields to clear. Although this field is currently supported, we\\nrecommend using null values or the `remove` field when possible. For examples, see\\n[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices).\",\n \"nullable\": true\n }\n },\n \"example\": {\n \"idempotency_key\": \"4ee82288-0910-499e-ab4c-5d0071dad1be\",\n \"invoice\": {\n \"payment_requests\": [\n {\n \"reminders\": null,\n \"tipping_enabled\": false,\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"version\": 1\n }\n }\n }\n }\n }\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }