{
  "opencollection": "1.0.0",
  "info": {
    "name": "Xentral Account ProformaInvoice API",
    "version": "v0.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "ProformaInvoice",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "🔒 List proforma invoices V3",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices",
            "headers": [
              {
                "name": "x-pagination",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The filter parameter is used to filter the results of the given endpoint. \n\n\n**Supported filter operators by key:** \n\n`id`: *equals*, *notEquals*, *in*, *notIn* \n\n`documentNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`writeProtection`: *equals*, *notEquals* \n\n`address.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`project.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`tags`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`tags.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`language`: *equals*, *notEquals*, *in*, *notIn* \n\n`bodyIntroduction`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`bodyOutroduction`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`project.abbreviation`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`internalDesignation`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`vatId`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deliveryTerms`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`internalComment`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`isDocumentSent`: *equals*, *notEquals* \n\n`editor.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`createdAt`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals*, *isNull*, *isNotNull* \n\n`updatedAt`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals*, *isNull*, *isNotNull* \n\n`documentAddress.name`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.title`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.contactPerson`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.department`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.subDepartment`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.addressSupplement`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.street`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.zipCode`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.city`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.state`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.country`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.gln`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.email`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.phone`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.fax`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`financials.paymentMethod.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`financials.tax.disableTaxNotice`: *equals*, *notEquals* \n\n`financials.tax.taxRates.standard`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.tax.taxRates.reduced`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.tax.taxation`: *equals*, *notEquals*, *in*, *notIn* \n\n`totals.net.amount`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`totals.net.currency`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`financials.paymentTerms.paymentTargetDays`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.paymentTerms.paymentTargetDiscount`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.paymentTerms.paymentTargetDiscountDays`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`sales.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`salesOrder.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`lineItems.product.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`lineItems.number`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`status`: *equals*, *notEquals*, *in*, *notIn*"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort via id, -id, documentNumber, -documentNumber, documentDate, -documentDate, customerNumber, -customerNumber, documentAddress.country, -documentAddress.country, project.id, -project.id, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is id"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Full-text-style search across predefined columns."
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Number of items per page. Default: 15, Max: 1000"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Only used with simple and table pagination."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter"
              }
            ]
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:read`.\n\nPaginated list of proforma invoices."
        },
        {
          "info": {
            "name": "🔒 Create proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:create`.\n\nCreate a new proforma invoice."
        },
        {
          "info": {
            "name": "🔒 View proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:read`.\n\nView a single proforma invoice.\n\n**Content Negotiation:** This endpoint supports additional response formats: `a"
        },
        {
          "info": {
            "name": "🔒 Update proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:update`.\n\nUpdate a proforma invoice."
        },
        {
          "info": {
            "name": "Delete proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:delete`.\n\nDelete a proforma invoice in status draft."
        },
        {
          "info": {
            "name": "Log custom proforma invoice activity V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/actions/logActivity",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:update`.\n\nRecord a custom activity log entry for a proforma invoice."
        },
        {
          "info": {
            "name": "Release proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/actions/release",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:release`.\n\nRelease a proforma invoice."
        },
        {
          "info": {
            "name": "Remove proforma invoice write protection V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/actions/removeWriteProtection",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:removeWriteProtection`.\n\nRemove write protection from a proforma invoice."
        },
        {
          "info": {
            "name": "Send proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/actions/send",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:send`.\n\nSend a proforma invoice."
        },
        {
          "info": {
            "name": "Set proforma invoice write protection V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/actions/setWriteProtection",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:setWriteProtection`.\n\nSet write protection for a proforma invoice."
        },
        {
          "info": {
            "name": "Attach file to proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/files",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:update`.\n\nAttach a file to a proforma invoice."
        },
        {
          "info": {
            "name": "Update file on proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/files/:fileId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:update`.\n\nUpdate a file attached to a proforma invoice."
        },
        {
          "info": {
            "name": "Delete file from proforma invoice V3",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/files/:fileId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:update`.\n\nDelete a file attached to a proforma invoice."
        },
        {
          "info": {
            "name": "🔒 Create proforma invoice line item V3",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/lineItems",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:update`.\n\nCreate a new proforma invoice line item."
        },
        {
          "info": {
            "name": "View proforma invoice line item V3",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/lineItems/:lineItemId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "lineItemId",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:read`.\n\nView a single proforma invoice line item."
        },
        {
          "info": {
            "name": "🔒 Update proforma invoice line item V3",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/lineItems/:lineItemId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "lineItemId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `proformaInvoice:update`.\n\nUpdate a line item in a proforma invoice."
        },
        {
          "info": {
            "name": "Delete proforma invoice line item V3",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{xentralId}.xentral.biz/api/v3/proformaInvoices/:id/lineItems/:lineItemId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "lineItemId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint requires the following scopes: `proformaInvoice:update`.\n\nDelete a line item from a proforma invoice."
        }
      ]
    }
  ],
  "bundled": true
}