{ "info": { "_postman_id": "020c82ca-18c8-43df-90ab-a173aeeede7c", "name": "Square ApplePay Invoices API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-020c82ca-18c8-43df-90ab-a173aeeede7c" }, "item": [ { "name": "v2", "item": [ { "name": "invoices", "item": [ { "name": "search", "item": [ { "name": "Square Search Invoices", "id": "fa8b12d8-2123-4b3e-90c3-e4126f6b760d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n },\n \"sort\": {\n \"field\": \"INVOICE_SORT_DATE\",\n \"order\": \"DESC\"\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", "search" ] }, "description": "Searches for invoices from a location specified in \nthe filter. You can optionally specify customers in the filter for whom to \nretrieve invoices. In the current implementation, you can only specify one location and \noptionally one customer.\n\nThe response is paginated. If truncated, the response includes a `cursor` \nthat you use in a subsequent request to retrieve the next set of invoices." }, "response": [ { "id": "c143fc83-66d5-4cb1-931a-103db37cb2d7", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n },\n \"sort\": {\n \"field\": \"INVOICE_SORT_DATE\",\n \"order\": \"DESC\"\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoices\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"CR\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"CHARGE_CARD_ON_FILE\",\n \"request_type\": \"DEPOSIT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"VEF\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"BANK_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"SENT\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"TRY\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"DJF\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"AFN\"\n }\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"COP\"\n },\n \"status\": \"PARTIALLY_REFUNDED\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"API_VERSION_INCOMPATIBLE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-c143fc83-66d5-4cb1-931a-103db37cb2d7" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-fa8b12d8-2123-4b3e-90c3-e4126f6b760d" } ], "id": "fe1ee8e6-6e25-4ea7-a156-1a7af8fc1f67", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-fe1ee8e6-6e25-4ea7-a156-1a7af8fc1f67" }, { "name": "{invoice_id}", "item": [ { "name": "attachments", "item": [ { "name": "{attachment_id}", "item": [ { "name": "Square Delete Invoice Attachment", "id": "a865abb7-a637-4b39-a95d-eb53de0420c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/attachments/:attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "attachments", ":attachment_id" ], "variable": [ { "id": "09a02777-6abf-447a-9082-6ef4ac691261", "key": "invoice_id", "value": "", "description": "(Required) The ID of the [invoice](entity:Invoice) to delete the attachment from." }, { "id": "0c3d91b5-8ded-4282-bcb6-1253341dd1c4", "key": "attachment_id", "value": "", "description": "(Required) The ID of the [attachment](entity:InvoiceAttachment) to delete." } ] }, "description": "Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only\nfrom invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state." }, "response": [ { "id": "6a1b9d6b-4c35-4a39-ae86-be317e8a9e4f", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/attachments/:attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "attachments", ":attachment_id" ], "variable": [ { "key": "invoice_id" }, { "key": "attachment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"UNSUPPORTED_COUNTRY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-6a1b9d6b-4c35-4a39-ae86-be317e8a9e4f" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-a865abb7-a637-4b39-a95d-eb53de0420c3" } ], "id": "3bcfa70c-bc96-4d1c-9cc2-b4bd449bc9cb", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-3bcfa70c-bc96-4d1c-9cc2-b4bd449bc9cb" }, { "name": "Square Create Invoice Attachment", "id": "4185932e-0caa-4a15-b7c9-ecc5ad272144", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) request.", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "attachments" ], "variable": [ { "id": "e7820b6b-1e11-4364-92de-0e53bed3e15d", "key": "invoice_id", "value": "", "description": "(Required) The ID of the [invoice](entity:Invoice) to attach the file to." } ] }, "description": "Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads\nwith a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file\nin a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.\n\nInvoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices\nin the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state." }, "response": [ { "id": "83f9785b-b9c9-4c67-a78e-3d4419add51e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "Represents a [CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) request.", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg" } ] }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "attachments" ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attachment\": {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_ACCOUNT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"V1_APPLICATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-83f9785b-b9c9-4c67-a78e-3d4419add51e" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-4185932e-0caa-4a15-b7c9-ecc5ad272144" } ], "id": "78415a23-a156-426c-a7ac-f6819cc3e838", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-78415a23-a156-426c-a7ac-f6819cc3e838" }, { "name": "cancel", "item": [ { "name": "Square Cancel Invoice", "id": "a703d84a-dc9d-4094-ad61-9b0b27601c26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "cancel" ], "variable": [ { "id": "db623445-b6a2-4179-9fb3-12a1966a7c10", "key": "invoice_id", "value": "", "description": "(Required) The ID of the [invoice](entity:Invoice) to cancel." } ] }, "description": "Cancels an invoice. The seller cannot collect payments for \nthe canceled invoice.\n\nYou cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`." }, "response": [ { "id": "1f2f3d8f-6ede-4f2f-bfdf-6c4737e24ca2", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "cancel" ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"FM\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS_CHARGE_CARD_ON_FILE\",\n \"request_type\": \"BALANCE\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"MXN\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"BANK_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"PENDING\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"ZAR\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SYP\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n }\n }\n ],\n \"delivery_method\": \"SHARE_MANUALLY\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SRD\"\n },\n \"status\": \"CANCELED\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"ABOVE_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"REQUEST_ENTITY_TOO_LARGE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-1f2f3d8f-6ede-4f2f-bfdf-6c4737e24ca2" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-a703d84a-dc9d-4094-ad61-9b0b27601c26" } ], "id": "af78a725-6573-4468-89b2-14e92b785fdf", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-af78a725-6573-4468-89b2-14e92b785fdf" }, { "name": "publish", "item": [ { "name": "Square Publish Invoice", "id": "c4ae5a2c-6618-491c-afff-3429d84309b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/publish", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "publish" ], "variable": [ { "id": "73ed1f34-cab0-4852-91b2-7e56e68ec527", "key": "invoice_id", "value": "", "description": "(Required) The ID of the invoice to publish." } ] }, "description": "Publishes the specified draft invoice. \n\nAfter an invoice is published, Square \nfollows up based on the invoice configuration. For example, Square \nsends the invoice to the customer's email address, charges the customer's card on file, or does \nnothing. Square also makes the invoice available on a Square-hosted invoice page. \n\nThe invoice `status` also changes from `DRAFT` to a status \nbased on the invoice configuration. For example, the status changes to `UNPAID` if \nSquare emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the \ninvoice amount.\n\nIn addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ`\nand `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments." }, "response": [ { "id": "4ea079d9-6fb2-4d1a-a37a-75bcaba64110", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id/publish", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id", "publish" ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"PK\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"EMAIL\",\n \"request_type\": \"BALANCE\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"BTN\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"SENT\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"TMT\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BRL\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"HRK\"\n }\n }\n ],\n \"delivery_method\": \"SHARE_MANUALLY\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SOS\"\n },\n \"status\": \"DRAFT\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"DELAYED_TRANSACTION_CAPTURED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-4ea079d9-6fb2-4d1a-a37a-75bcaba64110" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-c4ae5a2c-6618-491c-afff-3429d84309b4" } ], "id": "f6a0d0c5-2d65-48c5-a1c4-df9943a86360", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-f6a0d0c5-2d65-48c5-a1c4-df9943a86360" }, { "name": "Square Delete Invoice", "id": "a648a155-00a3-4d85-845e-0a9a63eeca12", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id?version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "query": [ { "description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices).", "key": "version", "value": "" } ], "variable": [ { "id": "e19bbe0d-f53b-423d-807d-cfad5f04a9ec", "key": "invoice_id", "value": "", "description": "(Required) The ID of the invoice to delete." } ] }, "description": "Deletes the specified invoice. When an invoice is deleted, the \nassociated order status changes to CANCELED. You can only delete a draft \ninvoice (you cannot delete a published invoice, including one that is scheduled for processing)." }, "response": [ { "id": "eb0fe8b5-006c-4ab4-934f-1a3e5d0645a0", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id?version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "query": [ { "description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices).", "key": "version", "value": "" } ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"BUYER_REFUSED_PAYMENT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"RESERVATION_DECLINED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-eb0fe8b5-006c-4ab4-934f-1a3e5d0645a0" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-a648a155-00a3-4d85-845e-0a9a63eeca12" }, { "name": "Square Get Invoice", "id": "2626b3d8-0bcc-4723-a772-2248e4650fea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "variable": [ { "id": "4ab8f076-c57a-4667-866a-8cc060de0738", "key": "invoice_id", "value": "", "description": "(Required) The ID of the invoice to retrieve." } ] }, "description": "Retrieves an invoice by invoice ID." }, "response": [ { "id": "f40e7a3f-93af-4f8d-9c38-8654867b6633", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"NP\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS\",\n \"request_type\": \"DEPOSIT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"JPY\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"BANK_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"NOT_APPLICABLE\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XAG\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XAF\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"ISK\"\n }\n }\n ],\n \"delivery_method\": \"SHARE_MANUALLY\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UGX\"\n },\n \"status\": \"PAYMENT_PENDING\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_ACCOUNT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-f40e7a3f-93af-4f8d-9c38-8654867b6633" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-2626b3d8-0bcc-4723-a772-2248e4650fea" }, { "name": "Square Update Invoice", "id": "0e0ac547-a502-4b2f-8b1e-ae7b69cde322", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"CG\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS\",\n \"request_type\": \"DEPOSIT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"OMR\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"NONE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"PENDING\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SYP\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"KWD\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"KGS\"\n }\n }\n ],\n \"delivery_method\": \"SMS\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UGX\"\n },\n \"status\": \"REFUNDED\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"ABOVE_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\",\n \"fields_to_clear\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "variable": [ { "id": "15a7c86d-b167-4a47-abf9-d2cb49db0a60", "key": "invoice_id", "value": "", "description": "(Required) The ID of the invoice to update." } ] }, "description": "Updates an invoice. This endpoint supports sparse updates, so you only need\nto specify the fields you want to change along with the required `version` field.\nSome restrictions apply to updating invoices. For example, you cannot change the\n`order_id` or `location_id` field." }, "response": [ { "id": "8103ae3d-6a38-4222-9c5b-a0bfbc5f88b7", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"CG\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS\",\n \"request_type\": \"DEPOSIT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"OMR\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"NONE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"PENDING\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SYP\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"KWD\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"KGS\"\n }\n }\n ],\n \"delivery_method\": \"SMS\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UGX\"\n },\n \"status\": \"REFUNDED\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"ABOVE_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\",\n \"fields_to_clear\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices/:invoice_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"BR\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS\",\n \"request_type\": \"DEPOSIT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"NZD\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"SENT\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"WST\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"HTG\"\n }\n }\n ],\n \"delivery_method\": \"SMS\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"IQD\"\n },\n \"status\": \"PAID\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"ABOVE_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_PHONE_NUMBER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-8103ae3d-6a38-4222-9c5b-a0bfbc5f88b7" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-0e0ac547-a502-4b2f-8b1e-ae7b69cde322" } ], "id": "609a2402-48dd-4d07-af26-b381ac403f7e", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-609a2402-48dd-4d07-af26-b381ac403f7e" }, { "name": "Square List Invoices", "id": "cc34ddc5-b075-42f3-aa19-3a3c24a17ec4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoices?location_id=&cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices" ], "query": [ { "description": "(Required) The ID of the location for which to list invoices.", "key": "location_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices.", "key": "limit", "value": "" } ] }, "description": "Returns a list of invoices for a given location. The response \nis paginated. If truncated, the response includes a `cursor` that you \nuse in a subsequent request to retrieve the next set of invoices." }, "response": [ { "id": "58cbc395-de0b-4de2-9336-ebb5ffeb4354", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/invoices?location_id=&cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices" ], "query": [ { "description": "(Required) The ID of the location for which to list invoices.", "key": "location_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices.", "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoices\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"SX\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"CHARGE_CARD_ON_FILE\",\n \"request_type\": \"INSTALLMENT\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"ZAR\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"NONE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"PENDING\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BBD\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"LKR\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"HUF\"\n }\n }\n ],\n \"delivery_method\": \"SMS\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"QAR\"\n },\n \"status\": \"UNPAID\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"DELAYED_TRANSACTION_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-58cbc395-de0b-4de2-9336-ebb5ffeb4354" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-cc34ddc5-b075-42f3-aa19-3a3c24a17ec4" }, { "name": "Square Create Invoice", "id": "d0c0b31d-397b-4900-81e6-03a25997581d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"AS\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SHARE_MANUALLY\",\n \"request_type\": \"BALANCE\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"HKD\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"BANK_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"NOT_APPLICABLE\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CRC\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"PAB\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"FKP\"\n }\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GBP\"\n },\n \"status\": \"PAID\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices" ] }, "description": "Creates a draft [invoice](entity:Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer's email address or charge the customer\u2019s card on file)." }, "response": [ { "id": "187f94ad-3687-4dd5-a8d6-2775a75cb7d1", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"AS\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SHARE_MANUALLY\",\n \"request_type\": \"BALANCE\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"HKD\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"BANK_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"NOT_APPLICABLE\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CRC\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"PAB\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"FKP\"\n }\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GBP\"\n },\n \"status\": \"PAID\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/invoices", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invoice\": {\n \"id\": \"\",\n \"version\": \"\",\n \"location_id\": \"\",\n \"order_id\": \"\",\n \"primary_recipient\": {\n \"customer_id\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"KY\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"company_name\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n },\n \"payment_requests\": [\n {\n \"uid\": \"\",\n \"request_method\": \"SMS_CHARGE_CARD_ON_FILE\",\n \"request_type\": \"BALANCE\",\n \"due_date\": \"\",\n \"fixed_amount_requested_money\": {\n \"amount\": \"\",\n \"currency\": \"SAR\"\n },\n \"percentage_requested\": \"\",\n \"tipping_enabled\": \"\",\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"\",\n \"reminders\": [\n {\n \"uid\": \"\",\n \"relative_scheduled_days\": \"\",\n \"message\": \"\",\n \"status\": \"NOT_APPLICABLE\",\n \"sent_at\": \"\"\n }\n ],\n \"computed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CNY\"\n },\n \"total_completed_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"MKD\"\n },\n \"rounding_adjustment_included_money\": {\n \"amount\": \"\",\n \"currency\": \"AZN\"\n }\n }\n ],\n \"delivery_method\": \"SHARE_MANUALLY\",\n \"invoice_number\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduled_at\": \"\",\n \"public_url\": \"\",\n \"next_payment_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n },\n \"status\": \"DRAFT\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"accepted_payment_methods\": {\n \"card\": \"\",\n \"square_gift_card\": \"\",\n \"bank_account\": \"\",\n \"buy_now_pay_later\": \"\",\n \"cash_app_pay\": \"\"\n },\n \"custom_fields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"placement\": \"BELOW_LINE_ITEMS\"\n }\n ],\n \"subscription_id\": \"\",\n \"sale_or_service_date\": \"\",\n \"payment_conditions\": \"\",\n \"store_payment_method_enabled\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"description\": \"\",\n \"filesize\": \"\",\n \"hash\": \"\",\n \"mime_type\": \"\",\n \"uploaded_at\": \"\"\n }\n ]\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"EXPIRATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-187f94ad-3687-4dd5-a8d6-2775a75cb7d1" } ], "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-d0c0b31d-397b-4900-81e6-03a25997581d" } ], "id": "3b2e3b03-a852-4ca7-b39d-75c28b0f258b", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-3b2e3b03-a852-4ca7-b39d-75c28b0f258b" } ], "id": "50bb2c74-3051-45a0-a40a-920244252ca0", "createdAt": "2026-07-28T03:03:56.000Z", "updatedAt": "2026-07-28T03:03:56.000Z", "uid": "35240-50bb2c74-3051-45a0-a40a-920244252ca0" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }