{ "info": { "_postman_id": "e375c6bd-a39c-4991-b3cd-9df170479f0f", "name": "Wingspan Payments 1099 Operations Bulk Operations API", "description": "Payments\n\nContact Support:\n Name: Wingspan API Support\n Email: support@wingspan.app", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:31:01.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "lastUpdatedBy": "35240", "uid": "35240-e375c6bd-a39c-4991-b3cd-9df170479f0f" }, "item": [ { "name": "payments", "item": [ { "name": "bulk", "item": [ { "name": "payable", "item": [ { "name": "batch", "item": [ { "name": "{batchId}", "item": [ { "name": "item", "item": [ { "name": "{batchItemId}", "item": [ { "name": "Retrieve a Specific Item from a Bulk Payable Batch", "id": "8644abc7-913c-422a-b44b-8489feb1d07f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "2d8055a6-eecf-4623-b8fc-b310b7f5f313", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "6fbc3c6a-3c70-4b7b-9a27-64d6aae36575", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Fetches detailed information of a specific item within a bulk payable batch, using both the batch ID and the item ID." }, "response": [ { "id": "dda57ec5-9d7a-46e9-84a8-2195cd887e91", "name": "An item that will be converted into a payable", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemId\": \"\",\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"laboris_b\": \"\",\n \"aute1d\": \"\",\n \"consectetur_de_\": \"\"\n },\n \"labels\": {\n \"dolore_8\": \"\",\n \"in9\": \"\",\n \"dolor_2bd\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"paidDate\": \"\",\n \"payableStatus\": \"Paid\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"integration\": \"\",\n \"lineItemDetail\": \"\",\n \"metadata\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": null\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dda57ec5-9d7a-46e9-84a8-2195cd887e91" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-8644abc7-913c-422a-b44b-8489feb1d07f" }, { "name": "Modify a Specific Item in a Bulk Payable Batch", "id": "51be05e6-a1d5-48e8-9aa5-01bff3b7c7f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"attachmentId\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"clientId\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"dueDate\": \"\",\n \"labels\": \"\",\n \"lineItemDescription\": \"\",\n \"lineItemDetail\": \"\",\n \"paidDate\": \"\",\n \"payableNotes\": \"\",\n \"payableStatus\": \"Paid\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "764c9a13-fcca-44c5-97dc-564bfecfbee6", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "84ffa462-e8b4-46ab-823a-97f923cf0227", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Updates the details or status of a specific item within a bulk payable batch, given both the batch ID and the item ID." }, "response": [ { "id": "133a1f1a-7cd9-4a40-b5b5-9a801e4358cc", "name": "An item that will be converted into a payable", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"attachmentId\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"clientId\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"dueDate\": \"\",\n \"labels\": \"\",\n \"lineItemDescription\": \"\",\n \"lineItemDetail\": \"\",\n \"paidDate\": \"\",\n \"payableNotes\": \"\",\n \"payableStatus\": \"Paid\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemId\": \"\",\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"laboris_b\": \"\",\n \"aute1d\": \"\",\n \"consectetur_de_\": \"\"\n },\n \"labels\": {\n \"dolore_8\": \"\",\n \"in9\": \"\",\n \"dolor_2bd\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"paidDate\": \"\",\n \"payableStatus\": \"Paid\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"integration\": \"\",\n \"lineItemDetail\": \"\",\n \"metadata\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": null\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-133a1f1a-7cd9-4a40-b5b5-9a801e4358cc" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-51be05e6-a1d5-48e8-9aa5-01bff3b7c7f7" } ], "id": "64385f38-f0f5-473f-9a0b-6d0a2171619b", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-64385f38-f0f5-473f-9a0b-6d0a2171619b" }, { "name": "Retrieve all items from a specific bulk payable batch", "id": "9c9992d2-a961-481d-afac-4618f5fcaa2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item" ], "variable": [ { "id": "6e69b019-64db-49cb-8921-c72fc045f75e", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Fetches and lists all individual payable items associated with a specified bulk payable batch. Useful for tracking and verifying batch details." }, "response": [ { "id": "8520bc49-140e-4ff2-9968-5a2135015fc7", "name": "A list of bulk payable items", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemId\": \"\",\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"dolor_e\": \"\",\n \"dolor_\": \"\",\n \"consecteturbe\": \"\"\n },\n \"labels\": {\n \"deserunt_6\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"paidDate\": \"\",\n \"payableStatus\": \"Approved\",\n \"status\": \"Failed\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"integration\": \"\",\n \"lineItemDetail\": \"\",\n \"metadata\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n },\n {\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemId\": \"\",\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"et79\": \"\"\n },\n \"labels\": {\n \"est8e8\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"paidDate\": \"\",\n \"payableStatus\": \"Approved\",\n \"status\": \"Failed\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"integration\": \"\",\n \"lineItemDetail\": \"\",\n \"metadata\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-8520bc49-140e-4ff2-9968-5a2135015fc7" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-9c9992d2-a961-481d-afac-4618f5fcaa2f" }, { "name": "Add a new item to a specific bulk payable batch", "id": "dd29ffe7-bc3d-4385-8875-0db1c529ece0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"dueDate\": \"\",\n \"lineItemDescription\": \"\",\n \"payableStatus\": \"Approved\",\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"clientId\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"labels\": \"\",\n \"lineItemDetail\": \"\",\n \"paidDate\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item" ], "variable": [ { "id": "78c8f71d-7c3e-45d3-8afb-af0a26584bc6", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows for the creation and addition of a new individual payable item into an existing bulk payable batch. This enhances batch management and payable tracking." }, "response": [ { "id": "b191c8c9-c9af-4b3b-8cce-76ad12734324", "name": "An item that will be converted into a payable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"dueDate\": \"\",\n \"lineItemDescription\": \"\",\n \"payableStatus\": \"Approved\",\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"clientId\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"labels\": \"\",\n \"lineItemDetail\": \"\",\n \"paidDate\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": \"Submitted\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkPayableBatchId\": \"\",\n \"bulkPayableItemId\": \"\",\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"laboris_b\": \"\",\n \"aute1d\": \"\",\n \"consectetur_de_\": \"\"\n },\n \"labels\": {\n \"dolore_8\": \"\",\n \"in9\": \"\",\n \"dolor_2bd\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"paidDate\": \"\",\n \"payableStatus\": \"Paid\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"attachmentId\": \"\",\n \"bulkPayableItemMergeKey\": \"\",\n \"bulkPayableItemReference\": \"\",\n \"collaboratorEmail\": \"\",\n \"collaboratorExternalId\": \"\",\n \"collaboratorId\": \"\",\n \"integration\": \"\",\n \"lineItemDetail\": \"\",\n \"metadata\": \"\",\n \"payableNotes\": \"\",\n \"reimbursableExpense\": \"\",\n \"workflowSubStatus\": null\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-b191c8c9-c9af-4b3b-8cce-76ad12734324" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dd29ffe7-bc3d-4385-8875-0db1c529ece0" } ], "id": "ce22bf28-9d2e-4b06-8b84-8e016febafc9", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ce22bf28-9d2e-4b06-8b84-8e016febafc9" }, { "name": "import-summary", "item": [ { "name": "Fetch the import summary for a specific bulk payable batch", "id": "32ca363b-3ca9-4624-81f7-3f1af5e95a75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/import-summary", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "import-summary" ], "variable": [ { "id": "242c5243-52f8-4da4-9c47-7dcb14c6aaef", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Provides an overview and summary of the import process for a given bulk payable batch, allowing for tracking of imported items, errors, and other relevant batch statistics." }, "response": [ { "id": "2b6de626-6561-46b6-9419-a1a1c7733ed8", "name": "Summary of the bulk payable import", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId/import-summary", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId", "import-summary" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deductionCollaboratorsCount\": \"\",\n \"netImportAmount\": \"\",\n \"payableCollaboratorsCount\": \"\",\n \"toBeCreatedDeductionsCount\": \"\",\n \"toBeCreatedPayablesCount\": \"\",\n \"toBeUpdatedDeductionsCount\": \"\",\n \"toBeUpdatedPayablesCount\": \"\",\n \"totalDeductionsAmount\": \"\",\n \"totalPayableItems\": \"\",\n \"totalPayablesAmount\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-2b6de626-6561-46b6-9419-a1a1c7733ed8" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-32ca363b-3ca9-4624-81f7-3f1af5e95a75" } ], "id": "dec7160e-dbc4-4d10-89de-9023e86103e3", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dec7160e-dbc4-4d10-89de-9023e86103e3" }, { "name": "Retrieve Details of a Specific Bulk Payable Batch", "id": "31d3ce75-7d9f-4883-b63d-8bbf1715e159", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "id": "f7bb2e94-0cd7-4d9c-b44b-4729dd78b439", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Fetches detailed information of a specific batch created for bulk payables, using the provided batch ID." }, "response": [ { "id": "dbe5a572-7170-421f-ba5e-59b0b2776eef", "name": "A batch of items for importing as payables", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": null,\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"et_5d2\": \"\",\n \"exercitationef\": \"\",\n \"amet1\": \"\"\n },\n \"labels\": {\n \"qui__\": \"\"\n },\n \"processingStrategy\": \"Single\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dbe5a572-7170-421f-ba5e-59b0b2776eef" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-31d3ce75-7d9f-4883-b63d-8bbf1715e159" }, { "name": "Modify a Specific Bulk Payable Batch", "id": "9fbf296e-74c2-4d56-9a77-92a137c6383a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "id": "5bee3433-8b04-4a76-91dd-02bef604cfb1", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Updates the information or items of a specific bulk payable batch, given its unique batch ID." }, "response": [ { "id": "dd2636ed-ee43-45c0-aac7-5db2647cea10", "name": "A batch of items for importing as payables", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": null,\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"et_5d2\": \"\",\n \"exercitationef\": \"\",\n \"amet1\": \"\"\n },\n \"labels\": {\n \"qui__\": \"\"\n },\n \"processingStrategy\": \"Single\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dd2636ed-ee43-45c0-aac7-5db2647cea10" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-9fbf296e-74c2-4d56-9a77-92a137c6383a" }, { "name": "Remove a Specific Bulk Payable Batch", "id": "c0407f73-69d2-45da-9c0c-dc4dc596bb7d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "id": "63aa5580-4dfc-474c-bf7b-65a98ea8ae3d", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Deletes a specific batch for bulk payables, using the provided batch ID, preventing any further operations on it." }, "response": [ { "id": "ea6d1bc2-2bef-4611-a1ff-87a9fbbd90fa", "name": "A batch of items for importing as payables", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": null,\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"et_5d2\": \"\",\n \"exercitationef\": \"\",\n \"amet1\": \"\"\n },\n \"labels\": {\n \"qui__\": \"\"\n },\n \"processingStrategy\": \"Single\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ea6d1bc2-2bef-4611-a1ff-87a9fbbd90fa" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-c0407f73-69d2-45da-9c0c-dc4dc596bb7d" } ], "id": "c3777b1f-9279-4004-92bb-07b67b324eb4", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-c3777b1f-9279-4004-92bb-07b67b324eb4" }, { "name": "Retrieve All Bulk Payable Batches", "id": "dfbdd5bc-073e-4c44-a94b-a6803c535444", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch" ] }, "description": "Fetches a list of all the batches created for bulk payables, providing an overview of the bulk payment operations." }, "response": [ { "id": "d38bb01e-0b2f-43ba-82db-e96615df0d0a", "name": "A list of bulk payable batches", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": null,\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"non51\": \"\"\n },\n \"labels\": {\n \"Lorem_e6\": \"\",\n \"aliquafb\": \"\",\n \"aliqua03d\": \"\"\n },\n \"processingStrategy\": \"Merge\",\n \"status\": \"Processing\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n },\n {\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Disabled\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"qui_0b\": \"\"\n },\n \"labels\": {\n \"non_6\": \"\",\n \"quis4f6\": \"\"\n },\n \"processingStrategy\": \"Merge\",\n \"status\": \"Failed\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-d38bb01e-0b2f-43ba-82db-e96615df0d0a" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-dfbdd5bc-073e-4c44-a94b-a6803c535444" }, { "name": "Initiate a New Bulk Payable Batch", "id": "196030cc-614a-4ddd-b28d-cb67e1eeccde", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"processingStrategy\": \"Single\",\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch" ] }, "description": "Creates a new batch for importing multiple payables at once, streamlining the bulk payment operations." }, "response": [ { "id": "4dce037b-c481-4836-b3f8-45dd6c11d23e", "name": "A batch of items for importing as payables", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"processingStrategy\": \"Single\",\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/payable/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "payable", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkPayableBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": null,\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"et_5d2\": \"\",\n \"exercitationef\": \"\",\n \"amet1\": \"\"\n },\n \"labels\": {\n \"qui__\": \"\"\n },\n \"processingStrategy\": \"Single\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-4dce037b-c481-4836-b3f8-45dd6c11d23e" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-196030cc-614a-4ddd-b28d-cb67e1eeccde" } ], "id": "5c461062-57bc-441e-aaa8-ac644452b68d", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-5c461062-57bc-441e-aaa8-ac644452b68d" } ], "id": "4bc3cdb3-c302-47f9-8857-eed7715a9328", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-4bc3cdb3-c302-47f9-8857-eed7715a9328" }, { "name": "invoice", "item": [ { "name": "batch", "item": [ { "name": "{batchId}", "item": [ { "name": "item", "item": [ { "name": "{batchItemId}", "item": [ { "name": "Retrieve a specific item from a bulk invoice batch", "id": "93870543-83ec-4bc5-a3a6-fa60695e5a9e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "72d415fb-e672-494e-a80e-5524f75a660a", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "403802c6-49d3-4bf7-98a6-6bf920396940", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Fetches detailed information about a specific item located within a designated bulk invoice batch. Useful for obtaining particular item data without browsing the entire batch." }, "response": [ { "id": "fca921af-c2d4-4b7b-b7ed-e68da4a36952", "name": "An item that will be converted into a invoice", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"labore4\": \"\",\n \"site\": \"\"\n },\n \"invoiceStatus\": \"Cancelled\",\n \"labels\": {\n \"ut297\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"memberId\": \"\",\n \"paidDate\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"acceptedPaymentMethods\": [\n \"Credit\",\n \"Credit\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"integration\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNotes\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"metadata\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-fca921af-c2d4-4b7b-b7ed-e68da4a36952" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-93870543-83ec-4bc5-a3a6-fa60695e5a9e" }, { "name": "Modify a specific item within a bulk invoice batch", "id": "132b7ede-5fc2-46f4-9562-32433f83be5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"acceptedPaymentMethods\": null,\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"dueDate\": \"\",\n \"invoiceNotes\": \"\",\n \"invoiceStatus\": \"Paid\",\n \"labels\": \"\",\n \"lineItemDescription\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"paidDate\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "a5291fb3-1177-451b-bd67-e5d051d680e9", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "b26ad177-b0dc-45f0-826e-19230b869663", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Allows for updates or edits to be made to a specific items details within an existing bulk invoice batch. Enhances the flexibility and management of invoice data." }, "response": [ { "id": "ed6b1c90-cfe3-40a2-8c98-284fa0b2d53a", "name": "An item that will be converted into a invoice", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"acceptedPaymentMethods\": null,\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"dueDate\": \"\",\n \"invoiceNotes\": \"\",\n \"invoiceStatus\": \"Paid\",\n \"labels\": \"\",\n \"lineItemDescription\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"paidDate\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"labore4\": \"\",\n \"site\": \"\"\n },\n \"invoiceStatus\": \"Cancelled\",\n \"labels\": {\n \"ut297\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"memberId\": \"\",\n \"paidDate\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"acceptedPaymentMethods\": [\n \"Credit\",\n \"Credit\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"integration\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNotes\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"metadata\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ed6b1c90-cfe3-40a2-8c98-284fa0b2d53a" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-132b7ede-5fc2-46f4-9562-32433f83be5c" } ], "id": "ec9102bc-b8fd-4e70-b8e8-b807abe6322f", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ec9102bc-b8fd-4e70-b8e8-b807abe6322f" }, { "name": "Fetch all items from a specific bulk invoice batch", "id": "64cfc0db-487c-47c1-9b02-319701d1796c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item" ], "variable": [ { "id": "a26022fc-c734-4a4a-9e3e-3ad798b7529c", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Provides a list of all the items within a specified batch of bulk invoices, identified by its unique batch identifier." }, "response": [ { "id": "6f3f5f0c-7799-4a7c-bdf3-8041b58dd112", "name": "A list of bulk invoice items", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"consectetur__e\": \"\"\n },\n \"invoiceStatus\": \"Cancelled\",\n \"labels\": {\n \"laboris65\": \"\",\n \"irure_05\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"memberId\": \"\",\n \"paidDate\": \"\",\n \"status\": \"Open\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"acceptedPaymentMethods\": null,\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"integration\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNotes\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"metadata\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n },\n {\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"Duis_e\": \"\",\n \"ullamcof04\": \"\",\n \"minim_0c\": \"\"\n },\n \"invoiceStatus\": \"Approved\",\n \"labels\": {\n \"enim1a\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"memberId\": \"\",\n \"paidDate\": \"\",\n \"status\": \"Open\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"acceptedPaymentMethods\": [\n \"Manual\",\n \"Manual\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"integration\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNotes\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"metadata\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-6f3f5f0c-7799-4a7c-bdf3-8041b58dd112" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-64cfc0db-487c-47c1-9b02-319701d1796c" }, { "name": "Add a new item to a specific bulk invoice batch", "id": "24a9ac72-5968-4f2f-8ec2-e72f8a43132f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"dueDate\": \"\",\n \"invoiceStatus\": \"Paid\",\n \"lineItemDescription\": \"\",\n \"acceptedPaymentMethods\": [\n \"ACH\",\n \"Manual\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"invoiceNotes\": \"\",\n \"labels\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"paidDate\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item" ], "variable": [ { "id": "94e5148b-d696-4120-95f2-ede2b7a103bd", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows users to append a new item to a given batch of bulk invoices by supplying its unique batch identifier and the details of the new item." }, "response": [ { "id": "8176e097-fd93-498e-bf1c-a8fae2c3dc27", "name": "An item that will be converted into a invoice", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"dueDate\": \"\",\n \"invoiceStatus\": \"Paid\",\n \"lineItemDescription\": \"\",\n \"acceptedPaymentMethods\": [\n \"ACH\",\n \"Manual\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"invoiceNotes\": \"\",\n \"labels\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"paidDate\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"bulkInvoiceBatchId\": \"\",\n \"bulkInvoiceItemId\": \"\",\n \"createdAt\": \"\",\n \"dueDate\": \"\",\n \"eventActors\": {\n \"labore4\": \"\",\n \"site\": \"\"\n },\n \"invoiceStatus\": \"Cancelled\",\n \"labels\": {\n \"ut297\": \"\"\n },\n \"lineItemDescription\": \"\",\n \"memberId\": \"\",\n \"paidDate\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"acceptedPaymentMethods\": [\n \"Credit\",\n \"Credit\"\n ],\n \"bulkInvoiceItemMergeKey\": \"\",\n \"bulkInvoiceItemReference\": \"\",\n \"clientEmail\": \"\",\n \"clientExternalId\": \"\",\n \"creditFeeHandling\": \"\",\n \"integration\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNotes\": \"\",\n \"lineItemDetail\": \"\",\n \"memberClientId\": \"\",\n \"metadata\": \"\",\n \"projectName\": \"\",\n \"reimbursableExpense\": \"\",\n \"sendDate\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-8176e097-fd93-498e-bf1c-a8fae2c3dc27" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-24a9ac72-5968-4f2f-8ec2-e72f8a43132f" } ], "id": "cfc4844f-6528-4312-bb1b-92a52785de82", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-cfc4844f-6528-4312-bb1b-92a52785de82" }, { "name": "Retrieve details of a specific bulk invoice batch", "id": "405a4f2c-ad3b-4d74-9bc9-c17df4cdb2bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId" ], "variable": [ { "id": "81ac0964-4b49-43b6-8e58-a3a6359cfd79", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows for the retrieval of a specified batch of bulk invoices by providing its unique batch identifier." }, "response": [ { "id": "ff2a3d9b-d390-44ed-9711-14bb68ce7e16", "name": "A batch of items for importing as invoices", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkInvoiceBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"enimd\": \"\",\n \"occaecat_b6\": \"\"\n },\n \"labels\": {\n \"autea\": \"\",\n \"elit29\": \"\"\n },\n \"memberId\": \"\",\n \"processingStrategy\": \"Merge\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ff2a3d9b-d390-44ed-9711-14bb68ce7e16" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-405a4f2c-ad3b-4d74-9bc9-c17df4cdb2bb" }, { "name": "Modify the details of a specific bulk invoice batch", "id": "384790ce-9a61-4c28-80da-a05d24c87179", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId" ], "variable": [ { "id": "1a40b67e-3d97-4693-a9bd-386938ea8bfd", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Enables the user to update or modify the attributes of a given batch of bulk invoices by specifying its unique batch identifier." }, "response": [ { "id": "7abcd6d8-fa3c-42cd-91cc-f74a572a1bda", "name": "A batch of items for importing as invoices", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkInvoiceBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"enimd\": \"\",\n \"occaecat_b6\": \"\"\n },\n \"labels\": {\n \"autea\": \"\",\n \"elit29\": \"\"\n },\n \"memberId\": \"\",\n \"processingStrategy\": \"Merge\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-7abcd6d8-fa3c-42cd-91cc-f74a572a1bda" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-384790ce-9a61-4c28-80da-a05d24c87179" } ], "id": "959ecaa2-cbbc-4e21-86e2-b1e90d02d3ae", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-959ecaa2-cbbc-4e21-86e2-b1e90d02d3ae" }, { "name": "Retrieve All Bulk Invoice Batches", "id": "59eb3882-11a8-4f15-9ed2-afdf850cb25c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch" ] }, "description": "Fetches a list of all the batches created for bulk invoices, providing an overview of the bulk invoicing operations." }, "response": [ { "id": "4dfc9364-0a47-4c12-9890-768ca3d852f4", "name": "A list of bulk invoice batches", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkInvoiceBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"non_e\": \"\",\n \"in_b\": \"\"\n },\n \"labels\": {\n \"quis_74d\": \"\"\n },\n \"memberId\": \"\",\n \"processingStrategy\": \"Merge\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n },\n {\n \"bulkInvoiceBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"officia_ad\": \"\",\n \"sed2f\": \"\"\n },\n \"labels\": {\n \"adipisicing_35f\": \"\",\n \"esse_7a\": \"\"\n },\n \"memberId\": \"\",\n \"processingStrategy\": \"Single\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-4dfc9364-0a47-4c12-9890-768ca3d852f4" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-59eb3882-11a8-4f15-9ed2-afdf850cb25c" }, { "name": "Initiate a New Bulk Invoice Batch", "id": "d4566fcd-2695-413e-9080-050565e8a039", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"processingStrategy\": \"Single\",\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch" ] }, "description": "Creates a new batch for importing multiple invoices at once, streamlining the bulk invoicing operations." }, "response": [ { "id": "53538c85-8815-40e7-88da-ea3ff574a90e", "name": "A batch of items for importing as invoices", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"processingStrategy\": \"Single\",\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/invoice/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "invoice", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkInvoiceBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"enimd\": \"\",\n \"occaecat_b6\": \"\"\n },\n \"labels\": {\n \"autea\": \"\",\n \"elit29\": \"\"\n },\n \"memberId\": \"\",\n \"processingStrategy\": \"Merge\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-53538c85-8815-40e7-88da-ea3ff574a90e" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-d4566fcd-2695-413e-9080-050565e8a039" } ], "id": "af04591f-1acb-484f-9528-49c282af8d33", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-af04591f-1acb-484f-9528-49c282af8d33" } ], "id": "eb66645b-e9c5-435b-90b7-f0618acbd03a", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-eb66645b-e9c5-435b-90b7-f0618acbd03a" }, { "name": "collaborator", "item": [ { "name": "batch", "item": [ { "name": "{batchId}", "item": [ { "name": "item", "item": [ { "name": "{batchItemId}", "item": [ { "name": "Retrieve details of a specific item from a collaborator batch", "id": "21188343-c436-433c-94a2-146dc7f646cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "0c15e4e9-206e-4a48-8030-930cab3f09f3", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "8c8e9351-13a4-41a9-a919-59e686ac557a", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Enables fetching of detailed information about an individual item from a specified batch of collaborators using both the batch and item unique identifiers." }, "response": [ { "id": "72fdae75-d031-4d50-afb8-28ab6660153b", "name": "An item that will be converted into a collaborator", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"bulkCollaboratorItemId\": \"\",\n \"clientId\": \"\",\n \"collaboratorStatus\": \"Pending\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"qui_87\": \"\",\n \"consequat___9\": \"\",\n \"magna5\": \"\"\n },\n \"labels\": {\n \"doc\": \"\",\n \"non0\": \"\"\n },\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"memberId\": \"\",\n \"metadata\": \"\",\n \"orgSubAccountId\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-72fdae75-d031-4d50-afb8-28ab6660153b" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-21188343-c436-433c-94a2-146dc7f646cf" }, { "name": "Modify the details of a specific item within a collaborator batch", "id": "249b5958-61ec-47f6-81de-f044d1f71893", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"collaboratorStatus\": \"Active\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"labels\": \"\",\n \"orgSubAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "9056d333-17de-4dac-8a9d-70420ea6a747", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "9982144d-fbd0-4131-a6f2-6bc87d099b35", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Provides the functionality to update or alter the attributes of an item present in a given collaborator batch using the unique identifiers for both the batch and the item." }, "response": [ { "id": "e58a6307-827c-4dd3-ae12-888322288528", "name": "An item that will be converted into a collaborator", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"collaboratorStatus\": \"Active\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"labels\": \"\",\n \"orgSubAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"bulkCollaboratorItemId\": \"\",\n \"clientId\": \"\",\n \"collaboratorStatus\": \"Pending\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"qui_87\": \"\",\n \"consequat___9\": \"\",\n \"magna5\": \"\"\n },\n \"labels\": {\n \"doc\": \"\",\n \"non0\": \"\"\n },\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"memberId\": \"\",\n \"metadata\": \"\",\n \"orgSubAccountId\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-e58a6307-827c-4dd3-ae12-888322288528" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-249b5958-61ec-47f6-81de-f044d1f71893" } ], "id": "f3a30737-c7bc-4048-8065-e4007b27a508", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-f3a30737-c7bc-4048-8065-e4007b27a508" }, { "name": "Retrieve all items from a specific collaborator batch", "id": "47588340-c01c-41b3-bbbe-1678869bc1b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item" ], "variable": [ { "id": "c17d53ac-2d9b-4a6c-812d-caf0cae348f8", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Provides a comprehensive list of items present within a specified batch of collaborators, identifiable through its unique batch identifier." }, "response": [ { "id": "24a4bb8c-e838-41e9-a067-6fb1d2409ce1", "name": "A list of bulk collaborator items", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkCollaboratorBatchId\": \"\",\n \"bulkCollaboratorItemId\": \"\",\n \"clientId\": \"\",\n \"collaboratorStatus\": \"Pending\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"veniamc4e\": \"\",\n \"ullamco_3c\": \"\",\n \"culpa3c7\": \"\",\n \"sed_4\": \"\"\n },\n \"labels\": {\n \"sint_0\": \"\",\n \"nullad0\": \"\"\n },\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"memberId\": \"\",\n \"metadata\": \"\",\n \"orgSubAccountId\": \"\"\n },\n {\n \"bulkCollaboratorBatchId\": \"\",\n \"bulkCollaboratorItemId\": \"\",\n \"clientId\": \"\",\n \"collaboratorStatus\": \"Active\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"ea8\": \"\"\n },\n \"labels\": {\n \"dolore_bc_\": \"\",\n \"utcac\": \"\",\n \"elit_f8\": \"\"\n },\n \"status\": \"Failed\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"memberId\": \"\",\n \"metadata\": \"\",\n \"orgSubAccountId\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-24a4bb8c-e838-41e9-a067-6fb1d2409ce1" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-47588340-c01c-41b3-bbbe-1678869bc1b7" }, { "name": "Append a new item to a specific collaborator batch", "id": "e4c5f4f8-aa3e-4af0-9334-853372d8c49a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"collaboratorStatus\": \"Active\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"labels\": \"\",\n \"orgSubAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item" ], "variable": [ { "id": "d7e68b04-030e-42ec-bbb5-657369bb8560", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows for the addition of a new item to an existing batch of collaborators by providing the batchs unique identifier and item details." }, "response": [ { "id": "be29e1f6-ac16-4d1a-a236-72f578f050c0", "name": "An item that will be converted into a collaborator", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"collaboratorStatus\": \"Active\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"labels\": \"\",\n \"orgSubAccountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"bulkCollaboratorItemId\": \"\",\n \"clientId\": \"\",\n \"collaboratorStatus\": \"Pending\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"qui_87\": \"\",\n \"consequat___9\": \"\",\n \"magna5\": \"\"\n },\n \"labels\": {\n \"doc\": \"\",\n \"non0\": \"\"\n },\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"collaboratorGroupId\": \"\",\n \"collaboratorId\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"formW9Data\": \"\",\n \"memberId\": \"\",\n \"metadata\": \"\",\n \"orgSubAccountId\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-be29e1f6-ac16-4d1a-a236-72f578f050c0" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-e4c5f4f8-aa3e-4af0-9334-853372d8c49a" } ], "id": "7b737996-ca45-47dc-a871-2b29740ba2d8", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-7b737996-ca45-47dc-a871-2b29740ba2d8" }, { "name": "Retrieve Details of a Specific Collaborator Batch", "id": "cfb9c8de-e5ec-4af0-a09a-1f38f5bee3d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "id": "09eec483-8611-4cbb-ac37-ac811e5c0238", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Fetches detailed information of a specific bulk collaborator batch, using the provided batch ID." }, "response": [ { "id": "65b69a53-d598-4f37-925c-29e831ec3006", "name": "A batch of items for importing as collaborators", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Active\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"eaa\": \"\",\n \"reprehenderit550\": \"\"\n },\n \"labels\": {\n \"nulla5\": \"\",\n \"id_2c\": \"\",\n \"ut_3e4\": \"\"\n },\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-65b69a53-d598-4f37-925c-29e831ec3006" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-cfb9c8de-e5ec-4af0-a09a-1f38f5bee3d7" }, { "name": "Modify Details of a Bulk Collaborator Batch", "id": "cc4f29d0-2ff3-4d6a-8c48-f251f1245980", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "id": "233f93e2-33e6-40e5-a923-fadaffef71d8", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows for updating or altering the details and items within a specific bulk collaborator batch using the given batch ID." }, "response": [ { "id": "567a0efd-c719-44ce-9e4c-3e4c2d7d2d5f", "name": "A batch of items for importing as collaborators", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Active\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"eaa\": \"\",\n \"reprehenderit550\": \"\"\n },\n \"labels\": {\n \"nulla5\": \"\",\n \"id_2c\": \"\",\n \"ut_3e4\": \"\"\n },\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-567a0efd-c719-44ce-9e4c-3e4c2d7d2d5f" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-cc4f29d0-2ff3-4d6a-8c48-f251f1245980" }, { "name": "Remove a Specific Collaborator Batch", "id": "bd2c05fd-e56b-4b16-b98e-d3f7a8c0b189", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "id": "5bdd3848-8a17-45af-8a90-9255f1862281", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Deletes a specific bulk collaborator batch using its unique identifier. Once deleted, the batch cannot be recovered." }, "response": [ { "id": "76ffdc79-ff9a-4ef1-9148-9b0038fae371", "name": "A batch of items for importing as collaborators", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Active\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"eaa\": \"\",\n \"reprehenderit550\": \"\"\n },\n \"labels\": {\n \"nulla5\": \"\",\n \"id_2c\": \"\",\n \"ut_3e4\": \"\"\n },\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-76ffdc79-ff9a-4ef1-9148-9b0038fae371" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-bd2c05fd-e56b-4b16-b98e-d3f7a8c0b189" } ], "id": "a431c8b1-bde4-48d1-8e2d-3ce23f0fa9b0", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-a431c8b1-bde4-48d1-8e2d-3ce23f0fa9b0" }, { "name": "Fetch all bulk collaborator batches", "id": "866cfede-020a-4075-b47b-89da050f2bb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch" ] }, "description": "Provides a list of all existing bulk collaborator batches, allowing users to view and manage batches that have been created for collaboration purposes." }, "response": [ { "id": "c1c1ee76-1670-450a-b312-0cc710100a46", "name": "A list of bulk collaborator batches", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Active\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"nisi8\": \"\",\n \"Ut_e3\": \"\"\n },\n \"labels\": {\n \"irure83\": \"\",\n \"sintf7\": \"\"\n },\n \"status\": \"Processing\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n },\n {\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Disabled\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"ut_d1f\": \"\",\n \"culpaa\": \"\"\n },\n \"labels\": {\n \"consectetur3\": \"\",\n \"occaecat8_\": \"\",\n \"fugiat6\": \"\"\n },\n \"status\": \"Processing\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-c1c1ee76-1670-450a-b312-0cc710100a46" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-866cfede-020a-4075-b47b-89da050f2bb0" }, { "name": "Initiate a new bulk collaborator batch.", "id": "683cdd30-2e5a-4f2f-b5ed-3d6a7d5a5c56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch" ] }, "description": "Enables the creation of a new bulk collaborator batch, facilitating the bulk management and addition of collaborators for various projects or tasks." }, "response": [ { "id": "bb6077d1-25b7-4331-bda6-e6d7e007e1e8", "name": "A batch of items for importing as collaborators", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/collaborator/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "collaborator", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkCollaboratorBatchId\": \"\",\n \"client\": {\n \"user\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"profile\": \"\",\n \"settings\": \"\",\n \"status\": \"Active\",\n \"tag\": \"\"\n },\n \"profile\": \"\"\n },\n \"clientId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"eaa\": \"\",\n \"reprehenderit550\": \"\"\n },\n \"labels\": {\n \"nulla5\": \"\",\n \"id_2c\": \"\",\n \"ut_3e4\": \"\"\n },\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-bb6077d1-25b7-4331-bda6-e6d7e007e1e8" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-683cdd30-2e5a-4f2f-b5ed-3d6a7d5a5c56" } ], "id": "f66d34c2-d025-403d-b059-bc72ada2e80f", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-f66d34c2-d025-403d-b059-bc72ada2e80f" } ], "id": "46adcf77-2f7c-4e8b-8ded-c03e074d2abe", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-46adcf77-2f7c-4e8b-8ded-c03e074d2abe" }, { "name": "client", "item": [ { "name": "batch", "item": [ { "name": "{batchId}", "item": [ { "name": "item", "item": [ { "name": "{batchItemId}", "item": [ { "name": "Fetch Details of a Specific Item from a Client Batch", "id": "2f109a20-5cd0-4d93-bab9-28fb1f62a206", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "3b765b1e-e4b4-4d51-b954-daa4fdf24521", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "8b62e597-5ce3-4e34-80d8-2bc9d0d3f757", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Retrieves the detailed information of a specific item within the bulk client batch using both batch and item unique identifiers." }, "response": [ { "id": "fc6b9f02-18b9-47b4-89e0-b24c370e2c73", "name": "An item that will be converted into a client", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"bulkClientItemId\": \"\",\n \"clientStatus\": \"Inactive\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"esse__\": \"\",\n \"elit_f0a\": \"\"\n },\n \"labels\": {\n \"dolor_0\": \"\",\n \"ad4b\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"memberClientId\": \"\",\n \"memberData\": \"\",\n \"metadata\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-fc6b9f02-18b9-47b4-89e0-b24c370e2c73" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-2f109a20-5cd0-4d93-bab9-28fb1f62a206" }, { "name": "Modify Details of a Specific Item in a Client Batch", "id": "842d58ae-de84-45e7-8f42-e6e430a48794", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientStatus\": \"Pending\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"labels\": \"\",\n \"memberData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "id": "0b0a4161-2b3a-4339-b5ed-981da013f657", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" }, { "id": "a479b0de-6497-4460-9c39-0cb1f59ed69d", "key": "batchItemId", "value": "", "description": "(Required) Unique identifier for an item in a batch" } ] }, "description": "Allows modification of the details of a specific item within the bulk client batch, using the provided item and batch identifiers." }, "response": [ { "id": "9abf6347-0171-4fc1-a386-3750950e52cb", "name": "An item that will be converted into a client", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"clientStatus\": \"Pending\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"labels\": \"\",\n \"memberData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item/:batchItemId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item", ":batchItemId" ], "variable": [ { "key": "batchId" }, { "key": "batchItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"bulkClientItemId\": \"\",\n \"clientStatus\": \"Inactive\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"esse__\": \"\",\n \"elit_f0a\": \"\"\n },\n \"labels\": {\n \"dolor_0\": \"\",\n \"ad4b\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"memberClientId\": \"\",\n \"memberData\": \"\",\n \"metadata\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-9abf6347-0171-4fc1-a386-3750950e52cb" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-842d58ae-de84-45e7-8f42-e6e430a48794" } ], "id": "445ae5ad-ef6a-44b2-be14-dbd0cdd96f3b", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-445ae5ad-ef6a-44b2-be14-dbd0cdd96f3b" }, { "name": "Retrieve All Items from a Client Batch", "id": "92537da1-1b13-468d-9926-e67964528264", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item" ], "variable": [ { "id": "fd57fb8a-65a7-496f-9b84-e8e92f2df99f", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Fetches all items present in the specified bulk client batch, providing a comprehensive view of all client data in the batch." }, "response": [ { "id": "7816c562-ba84-4867-bcc2-e9384a1cb07b", "name": "A list of bulk client items", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkClientBatchId\": \"\",\n \"bulkClientItemId\": \"\",\n \"clientStatus\": \"Inactive\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"reprehenderit7_7\": \"\",\n \"ea89\": \"\"\n },\n \"labels\": {\n \"ad_4\": \"\",\n \"dolore28\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Open\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"memberClientId\": \"\",\n \"memberData\": \"\",\n \"metadata\": \"\"\n },\n {\n \"bulkClientBatchId\": \"\",\n \"bulkClientItemId\": \"\",\n \"clientStatus\": \"Pending\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"elit_3fb\": \"\",\n \"nostrudc1\": \"\",\n \"Lorem_9\": \"\"\n },\n \"labels\": {\n \"dolor_af\": \"\",\n \"in_b5\": \"\",\n \"ea_2c\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"memberClientId\": \"\",\n \"memberData\": \"\",\n \"metadata\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-7816c562-ba84-4867-bcc2-e9384a1cb07b" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-92537da1-1b13-468d-9926-e67964528264" }, { "name": "Add a New Item to a Client Batch", "id": "0578467d-e36a-4f9e-a908-977aae54855f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientStatus\": \"Pending\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"labels\": \"\",\n \"memberData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item" ], "variable": [ { "id": "6dc39af5-6ef1-4420-9ef6-a4b6acf133ca", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Inserts a new item into the specified bulk client batch, allowing for further expansion of client data within the batch." }, "response": [ { "id": "e8d88f8d-7b42-429d-ad50-2f976fa0b46d", "name": "An item that will be converted into a client", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"clientStatus\": \"Pending\",\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"labels\": \"\",\n \"memberData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId/item", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId", "item" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"bulkClientItemId\": \"\",\n \"clientStatus\": \"Inactive\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"esse__\": \"\",\n \"elit_f0a\": \"\"\n },\n \"labels\": {\n \"dolor_0\": \"\",\n \"ad4b\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"company\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstLastName\": \"\",\n \"integration\": \"\",\n \"memberClientId\": \"\",\n \"memberData\": \"\",\n \"metadata\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-e8d88f8d-7b42-429d-ad50-2f976fa0b46d" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-0578467d-e36a-4f9e-a908-977aae54855f" } ], "id": "6459667c-ea02-451d-86b3-a0ad7d049f7d", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-6459667c-ea02-451d-86b3-a0ad7d049f7d" }, { "name": "Fetch Details of a Specific Item from a Client Batch", "id": "12c55258-b369-421e-98f2-0d5f4a916025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId" ], "variable": [ { "id": "4c909b6e-5b70-4596-bed8-888b65d31184", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Retrieves the detailed information of a specific item within the bulk client batch using both batch and item unique identifiers." }, "response": [ { "id": "7dceb9fe-7379-4173-9b17-eb232bb83fbe", "name": "A batch of items for importing as clients", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"cupidatat_504\": \"\",\n \"sit_76\": \"\",\n \"dolor_1\": \"\",\n \"Duis2\": \"\",\n \"in912\": \"\"\n },\n \"labels\": {\n \"culpa_b20\": \"\",\n \"anim73\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-7dceb9fe-7379-4173-9b17-eb232bb83fbe" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-12c55258-b369-421e-98f2-0d5f4a916025" }, { "name": "Modify Details of a Specific Item in a Client Batch", "id": "d38f913b-f19c-4389-90b4-6145fcb50111", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId" ], "variable": [ { "id": "11a8f890-f1f8-48ee-a0ef-ad2010e25657", "key": "batchId", "value": "", "description": "(Required) Unique identifier for a batch" } ] }, "description": "Allows modification of the details of a specific item within the bulk client batch, using the provided item and batch identifiers." }, "response": [ { "id": "a32695bc-c664-42bb-9c3e-ddbff2e5603b", "name": "A batch of items for importing as clients", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\",\n \"status\": \"Pending\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"cupidatat_504\": \"\",\n \"sit_76\": \"\",\n \"dolor_1\": \"\",\n \"Duis2\": \"\",\n \"in912\": \"\"\n },\n \"labels\": {\n \"culpa_b20\": \"\",\n \"anim73\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-a32695bc-c664-42bb-9c3e-ddbff2e5603b" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-d38f913b-f19c-4389-90b4-6145fcb50111" } ], "id": "e217ba84-3873-4a2d-b2f3-cc9b78a4cd12", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-e217ba84-3873-4a2d-b2f3-cc9b78a4cd12" }, { "name": "Retrieve all bulk client batches", "id": "a201918a-6178-405b-84a6-b3d7164b99fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch" ] }, "description": "Provides an overview of all existing bulk client batches, allowing users to quickly ascertain and manage batches created for the purpose of client onboarding or import." }, "response": [ { "id": "bc957d6b-58bc-48cd-b06d-a3e130aaf452", "name": "A list of bulk client batches", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"bulkClientBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"minimca\": \"\",\n \"dolore_f\": \"\",\n \"etb\": \"\"\n },\n \"labels\": {\n \"ut_36\": \"\",\n \"eu15\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Processing\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n },\n {\n \"bulkClientBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"nulla_6e6\": \"\",\n \"commodof25\": \"\",\n \"et__65\": \"\",\n \"velit5\": \"\"\n },\n \"labels\": {\n \"veniam_b\": \"\",\n \"veniamf57\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Pending\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n }\n]", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-bc957d6b-58bc-48cd-b06d-a3e130aaf452" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-a201918a-6178-405b-84a6-b3d7164b99fb" }, { "name": "Create a new bulk client batch", "id": "ffa90f8e-21fc-46b4-ba4e-c5eeef0b7c0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch" ] }, "description": "Initiates the creation of a fresh bulk client batch, streamlining the process of adding multiple clients in one go." }, "response": [ { "id": "697ee4b4-57a1-4099-9336-dc148c07fd17", "name": "A batch of items for importing as clients", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"labels\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/bulk/client/batch", "host": [ "{{baseUrl}}" ], "path": [ "payments", "bulk", "client", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bulkClientBatchId\": \"\",\n \"createdAt\": \"\",\n \"eventActors\": {\n \"cupidatat_504\": \"\",\n \"sit_76\": \"\",\n \"dolor_1\": \"\",\n \"Duis2\": \"\",\n \"in912\": \"\"\n },\n \"labels\": {\n \"culpa_b20\": \"\",\n \"anim73\": \"\"\n },\n \"memberId\": \"\",\n \"status\": \"Complete\",\n \"updatedAt\": \"\",\n \"userRoles\": {\n \"ownerIds\": [\n \"\",\n \"\"\n ],\n \"viewerIds\": [\n \"\",\n \"\"\n ]\n },\n \"statistics\": \"\"\n}", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-697ee4b4-57a1-4099-9336-dc148c07fd17" } ], "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-ffa90f8e-21fc-46b4-ba4e-c5eeef0b7c0c" } ], "id": "85ba75c8-13b1-4b7b-a59b-86b6e80e77dd", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-85ba75c8-13b1-4b7b-a59b-86b6e80e77dd" } ], "id": "13c3817c-4e09-47eb-9ab0-6685cd3f6844", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-13c3817c-4e09-47eb-9ab0-6685cd3f6844" } ], "id": "a21e5e49-e6ec-4568-97e3-db0204b6ea28", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-a21e5e49-e6ec-4568-97e3-db0204b6ea28" } ], "id": "25025754-000f-4935-bfcf-867a25f7be3b", "createdAt": "2026-07-28T03:31:02.000Z", "updatedAt": "2026-07-28T03:31:02.000Z", "uid": "35240-25025754-000f-4935-bfcf-867a25f7be3b" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.wingspan.app" } ] }