Change Updates

Do not miss any Wyzio API changes, ever again

Subscribe to the Wyzio API changelog to be up to date on recent changes.

RSS

about 2 hours ago

main
1.0
Compare

API structure has changed

Next change
56 structure changes including:
50 Breaking changes
6 Additions
49 Modifications
1 Removal
Modified 49 Breaking
GET /api-v1/payable/overall
  • Path went from /api-v1/payroll/advanced/overall to /api-v1/payable/overall (same operationId)
    Breaking
GET /api-v1/payroll
  • Path went from /api-v1/payslip to /api-v1/payroll (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • cla, countryId, countryName, endDate, isRegionAvailable, regionName, startDate, type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • currencyCode, employee, employeeECorrespondence, employeeEmail, employeeId, grossSalary, monthNumber, monthType, netSalary, organizationEmployeeGroupId, organizationEmployeeGroupName, organizationId, payable, paymentDate, status properties Added
GET /api-v1/payroll/advanced/overall
  • Path went from /api-v1/payroll/overall to /api-v1/payroll/advanced/overall (same operationId)
    Breaking
GET /api-v1/payroll/overall
  • Path went from /api-v1/purchase-invoice-scan/overall to /api-v1/payroll/overall (same operationId)
    Breaking
GET /api-v1/payslip
  • Path went from /api-v1/receivable to /api-v1/payslip (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • chartId, chartName, chartNumber, comment, contact, contactId, currency, currencyId, entityCreatorContactId, hasWarnings, invoiceDate, invoiceId, invoiceNumber, module, organizationId, paymentFileReference, paymentId, requestedAmount, requestedDate, tenantId properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • calendarYear, cla, countryId, countryName, endDate, isRegionAvailable, regionName, startDate, type properties Added
GET /api-v1/purchase-invoice-scan/overall
  • Path went from /api-v1/receivable/overall to /api-v1/purchase-invoice-scan/overall (same operationId)
    Breaking
GET /api-v1/receivable
  • Path went from /api-v1/registry/publication to /api-v1/receivable (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type went from object to array[object]
        Breaking
      • id, mutation, publication, publicationDate, publicationId, uid properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ReceivableView property Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/receivable/overall
  • Path went from /api-v1/reconciliation-lines/overall to /api-v1/receivable/overall (same operationId)
    Breaking
GET /api-v1/reconciliation-lines/overall
  • Path went from /api-v1/registry/publication/overall to /api-v1/reconciliation-lines/overall (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type went from object to integer(int64)
        Breaking
      • id, mutation, publication, publicationDate, publicationId, uid properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /api-v1/registry/publication
  • Path went from /api-v1/role to /api-v1/registry/publication (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type went from array[object] to object
        Breaking
      • id, mutation, publication, publicationDate, publicationId, uid properties Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api-v1/registry/publication/overall
  • Path went from /api-v1/sales-invoice/overall to /api-v1/registry/publication/overall (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • Type went from integer(int64) to object
        Breaking
      • id, mutation, publication, publicationDate, publicationId, uid properties Added
GET /api-v1/role
  • Path went from /api-v1/sales-invoice to /api-v1/role (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • */* content type Added
GET /api-v1/sales-invoice
  • Path went from /api-v1/stock-movement-line to /api-v1/sales-invoice (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
GET /api-v1/sales-invoice/overall
  • Path went from /api-v1/stock-movement-line/overall to /api-v1/sales-invoice/overall (same operationId)
    Breaking
GET /api-v1/stock-movement-line
  • Path went from /api-v1/stock-report to /api-v1/stock-movement-line (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • articleId property Modified
        • Type went from integer to object
          Breaking
        • de, en, fr, it properties Added
      • articleIdToDisplay, articleName, categoryId, departmentId, inQuantity, officeId, outQuantity, quantityProjection, totalCost, totalQuantity properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • articleRealId, cost, currencyCode, entityCreatorContactId, id, movementDirection, ownerId, ownerType, quantity, quantityLeft, type properties Added
GET /api-v1/stock-movement-line/overall
  • Path went from /api-v1/stock-report/overall to /api-v1/stock-movement-line/overall (same operationId)
    Breaking
GET /api-v1/stock-report
  • Path went from /api-v1/sub-orders to /api-v1/stock-report (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • amount, contactName, endDate, id, invoicingDate, orderId, orderName, orderOriginalId, orderPeriodicityType, startDate, totalAmount, workflowPermissions properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • articleId, articleIdToDisplay, articleName, categoryId, date, departmentId, inQuantity, measurement, officeId, outQuantity, quantityProjection, totalCost, totalQuantity properties Added
GET /api-v1/stock-report/overall
  • Path went from /api-v1/sub-orders/overall to /api-v1/stock-report/overall (same operationId)
    Breaking
GET /api-v1/sub-orders
  • Path went from /api-v1/timesheet to /api-v1/sub-orders (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • orderId property Modified
        • Type went from integer to string
          Breaking
      • billableAmount, billableRate, client, clientContactId, costAmount, costRate, date, departmentId, description, employee, employeeContactId, flagsAmount, isBillable, isInWorkflow, order, orderIdOriginal, status, taskName, time properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • amount, contactName, endDate, invoicingDate, orderName, orderOriginalId, orderPeriodicityType, organizationId, startDate, totalAmount properties Added
GET /api-v1/sub-orders/overall
  • Path went from /api-v1/timesheet/advanced/overall to /api-v1/sub-orders/overall (same operationId)
    Breaking
GET /api-v1/timesheet
  • Path went from /api-v1/trash-can to /api-v1/timesheet (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • time property Modified
        • Type went from string(date-time) to number
          Breaking
      • contactEmail, contactId, entityCreatorContactId, entityId, entityName, localTime, module, organizationId, systemInfo, tenantId properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • billableAmount, billableRate, client, clientContactId, costAmount, costRate, departmentId, description, employee, employeeContactId, flagsAmount, isBillable, isInWorkflow, order, orderId, orderIdOriginal, status, taskName, workflowPermissions properties Added
GET /api-v1/timesheet/advanced/overall
  • Path went from /api-v1/timesheet/overall to /api-v1/timesheet/advanced/overall (same operationId)
    Breaking
GET /api-v1/timesheet/overall
  • Path went from /api-v1/user-group/advanced/overall to /api-v1/timesheet/overall (same operationId)
    Breaking
GET /api-v1/trash-can
  • Path went from /api-v1/user-group/advanced to /api-v1/trash-can (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • */* content type Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/user-group
  • Path went from /api-v1/vacation/{type} to /api-v1/user-group (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
  • Path
  • type path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/vacation/{type}/overall
  • Path went from /api-v1/workflow/overall to /api-v1/vacation/{type}/overall (same operationId)
    Breaking
  • Path
  • type path parameter Added
GET /api-v1/vacation/{type}
  • Path went from /api-v1/workflow to /api-v1/vacation/{type} (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • */* content type Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • type path parameter Added
GET /api-v1/user-group/overall
  • Path went from /api-v1/vacation/{type}/overall to /api-v1/user-group/overall (same operationId)
    Breaking
  • Path
  • type path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api-v1/user-group/advanced/overall
  • Path went from /api-v1/user-group/overall to /api-v1/user-group/advanced/overall (same operationId)
    Breaking
GET /api-v1/user-group/advanced
  • Path went from /api-v1/user-group to /api-v1/user-group/advanced (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • creatorContactId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • userIds property Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /api-v1/document/large-to-export
  • Path went from /api-v1/reconciliation-lines to /api-v1/document/large-to-export (same operationId)
    Breaking
  • Query
  • ids query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api-v1/document/large-to-export
  • Path went from /api-v1/late-notice to /api-v1/document/large-to-export (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • clientECorrespondence, clientEmail, clientId, clientLateNoticeEmail, clientName, openAmount, overdueAmount, qrBillDataExists properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • comments, contact, createdBy, createdOn, creatorId, date, deleted, entityCreatorContactId, entityId, fileExtension, fileId, fileName, id, isContactStaff, isDeleted, module, name, self, size, tags, tagsCount properties Added
GET /api-v1/document/large-to-export/overall
  • Path went from /api-v1/late-notice/overall to /api-v1/document/large-to-export/overall (same operationId)
    Breaking
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/late-notice
  • Path went from /api-v1/myaccount/expenses-report to /api-v1/late-notice (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • currency, date, id, netAmount, payable, reference, status, totalAmount, validated properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • clientECorrespondence, clientEmail, clientId, clientLateNoticeEmail, clientName, openAmount, overdueAmount, qrBillDataExists properties Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/late-notice/overall
  • Path went from /api-v1/myaccount/expenses-report/overall to /api-v1/late-notice/overall (same operationId)
    Breaking
GET /api-v1/my-expenses
  • Path went from /api-v1/my-payroll to /api-v1/my-expenses (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • calendarYear, currencyCode, employee, employeeECorrespondence, employeeEmail, employeeId, grossSalary, monthNumber, monthType, netSalary, organizationEmployeeGroupId, organizationEmployeeGroupName, payable, paymentDate, warnings properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • companyCurrencyTotalAmount, currency, currencyNetAmount, currencyTotalAmount, currencyVatAmount, date, description, merchant, reBill, receipt properties Added
GET /api-v1/my-expenses/advanced/overall
  • Path went from /api-v1/my-expenses/overall to /api-v1/my-expenses/advanced/overall (same operationId)
    Breaking
GET /api-v1/my-expenses/overall
  • Path went from /api-v1/my-payroll/overall to /api-v1/my-expenses/overall (same operationId)
    Breaking
GET /api-v1/my-payroll
  • Path went from /api-v1/my-workflow-notification to /api-v1/my-payroll (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • actionType, date, entities, entitiesAmount, moduleType, realModuleType, workflowId properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • calendarYear, currencyCode, employee, employeeECorrespondence, employeeEmail, employeeId, grossSalary, monthNumber, monthType, netSalary, organizationEmployeeGroupId, organizationEmployeeGroupName, organizationId, payable, paymentDate, status, warnings properties Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api-v1/my-payroll/overall
  • Path went from /api-v1/orders/overall to /api-v1/my-payroll/overall (same operationId)
    Breaking
GET /api-v1/my-workflow-notification
  • Path went from /api-v1/organization/currency-exchange to /api-v1/my-workflow-notification (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • currencyFrom, currencyTo, organizationId, rate properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • actionType, entities, entitiesAmount, moduleType, realModuleType, workflowId properties Added
GET /api-v1/myaccount/expenses-report
  • Path went from /api-v1/my-expenses to /api-v1/myaccount/expenses-report (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Modified
      • companyCurrencyTotalAmount, currencyNetAmount, currencyTotalAmount, currencyVatAmount, description, merchant, organizationId, reBill, receipt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • netAmount, payable, reference, totalAmount, validated properties Added
GET /api-v1/myaccount/expenses-report/overall
  • Path went from /api-v1/my-expenses/advanced/overall to /api-v1/myaccount/expenses-report/overall (same operationId)
    Breaking
GET /api-v1/order-reports/overall
  • Path went from /api-v1/payable/advanced/overall to /api-v1/order-reports/overall (same operationId)
    Breaking
GET /api-v1/orders/overall
  • Path went from /api-v1/order-reports/overall to /api-v1/orders/overall (same operationId)
    Breaking
GET /api-v1/organization/currency-exchange
  • Path went from /api-v1/payable/advanced to /api-v1/organization/currency-exchange (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • */* content type Added
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Added
GET /api-v1/payable
  • Path went from /api-v1/payroll to /api-v1/payable (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • */* content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/json content type Added
GET /api-v1/payable/advanced
  • Path went from /api-v1/payable to /api-v1/payable/advanced (same operationId)
    Breaking
  • Query
  • direction, pageNumber, sizePerPage, sortingField query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api-v1/payable/advanced/overall
  • Path went from /api-v1/payable/overall to /api-v1/payable/advanced/overall (same operationId)
    Breaking
Removed 1 Breaking
GET /api-v1/list/vat/rate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
GET /api-v1/workflow/overall
GET /api-v1/workflow
GET /api-v1/list/vat/rate
GET /api-v1/document/large-to-export/download/{id}
DELETE /api-v1/reconciliation-lines
DELETE /api-v1/document/large-to-export/{id}