Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Path parameters

• id integer Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer
  • journalEntryId integer
  • number string
  • date string

    Minimum length is 1.

  • clientId integer Required
  • clientAddressId integer
  • address object
    Hide address attributes Show address attributes object

    • id integer
    • name string

      Minimum length is 1.

    • line1 string
    • line2 string
    • city string
    • region object
      Hide region attributes Show region attributes object

      • id integer
      • name string
      • code string
      • taxMode string

        Values are ANNUALLY or MONTHLY.

    • countryCode2 string
    • postCode string
    • toTheAttentionOf string
    • position integer(int32)
    • houseNumber string
    • countryId integer Required
    • service string
    • readOnly boolean
  • ourContactId integer
  • yourContactId integer
  • clientName string
  • reference string
  • yourReference string
  • currencyId integer Required
  • description string
  • comments string
  • warnings string
  • receivableAccountId integer
  • vatTypeCodeId integer
  • excludedFromVat boolean
  • invoiceLines array[object]

    At least 1 element.

    Hide invoiceLines attributes Show invoiceLines attributes object

    • id integer
    • tempId integer
    • lineType string

      Values are ARTICLE, NO_ARTICLE, TIMESHEET, EXPENSES, DISBURSEMENT, HEADER, or FIXED_ASSET.

    • quantity number Required
    • articleId integer
    • isArticleShipped boolean
    • description string
    • longDescription string
    • netUnitPrice number Required
    • discount number Required
    • totalNet number Required
    • vatRateId integer
    • vat number
    • totalPrice number
    • saleAccountId integer Required
    • departmentId integer
    • allocationKey string
    • appliedAllocationRules array[string]
    • vatTypeCodeId integer
    • articleName object
      Hide articleName attributes Show articleName attributes object

      • en string
      • fr string
      • de string
      • it string
    • saleAccountName object
      Hide saleAccountName attributes Show saleAccountName attributes object

      • en string
      • fr string
      • de string
      • it string
    • departmentName string
    • fixedAssetName string
    • fixedAssetId integer
    • officeId integer
    • officeName string
  • invoiceLinesLayout array[object]
    Hide invoiceLinesLayout attributes Show invoiceLinesLayout attributes object

    • id integer
    • name string
    • parentId integer
    • position integer(int32)
    • lineType string

      Values are ARTICLE, NO_ARTICLE, TIMESHEET, EXPENSES, DISBURSEMENT, HEADER, or FIXED_ASSET.

    • salesInvoiceLineId integer
    • sourceOrderId integer
  • payments array[object]
    Hide payments attributes Show payments attributes object

    • id integer
    • receivableByAccountId integer Required
    • requestedDate string

      Minimum length is 1.

    • overdueDate string

      Minimum length is 1.

    • valueDate string
    • sentDate string
    • requestedAmount string
    • paidAmount string
    • bankCharges string
    • lossOnDebtors string
    • isFromLockedAccountingPeriod boolean
    • qrBillData string
    • receivableByAccountName object
      Hide receivableByAccountName attributes Show receivableByAccountName attributes object

      • en string
      • fr string
      • de string
      • it string
  • shipments array[object]
    Hide shipments attributes Show shipments attributes object

    • id integer
    • shipmentDate string
    • articleId integer
    • quantity string
    • currencyCode string
    • totalCost number
    • generatedStockMovementId integer
    • articleName object
      Hide articleName attributes Show articleName attributes object

      • en string
      • fr string
      • de string
      • it string
    • articleIdSku string
    • officeId integer
    • orderArticleId integer
    • salesInvoiceLineId integer
  • timesheetInfoItems array[object]
    Hide timesheetInfoItems attributes Show timesheetInfoItems attributes object

    • id integer
    • date string
    • description string
    • time string
    • billableAmount string
    • billableRate string
    • employeeContactId integer
    • originalTimesheetId integer
    • employeeTaskId integer
  • sourceOrderId integer
  • sourceSubOrderId integer
  • bvrGenerationAvailability boolean
  • qrGenerationAvailability boolean
  • isFromLockedAccountingPeriod boolean
  • isContainsFixedAsset boolean
  • accrualFrom string
  • accrualTo string
  • accrualEntriesAmount integer(int32)
  • validated boolean
  • validatorUserIdsSize integer
  • validatorUserIds array[integer(int32)]
  • realValidated boolean
  • systemValidated boolean
  • canEditProformaFlag boolean
  • isDocSent boolean
  • ourContactName string
  • yourContactName string
  • receivableAccountName object
    Hide receivableAccountName attributes Show receivableAccountName attributes object

    • en string
    • fr string
    • de string
    • it string
  • clientAddressName string
  • startDate string
  • endDate string
  • proforma boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error