Sign in
Debt Positions API

The Organization creates a debt Position.

post/organizations/{organizationfiscalcode}/debtpositions

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

Query parameters

toPublishboolean

Request body

iupdstring required
type'F' | 'G' required
payStandInboolean

feature flag to enable a debt position in stand-in mode

fiscalCodestring required
fullNamestring required
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean required

feature flag to enable the debt position to expire after the due date

companyNamestring required
officeNamestring
validityDatestring date-time
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PARTIALLY_PAID' | 'PAID' | 'REPORTED'

Example request

{
  "payStandIn": true,
  "country": "IT",
  "email": "email@domain.com",
  "paymentOption": [
    {
      "transfer": [
        {
          "organizationFiscalCode": "00000000000",
          "iban": "IT0000000000000000000000000",
          "postalIban": "IT0000000000000000000000000",
          "stamp": {
            "provincialResidence": "RM"
          }
        }
      ]
    }
  ]
}

Response

Request created.

iupdstring required
type'F' | 'G' required
payStandInboolean

feature flag to enable a debt position in stand-in mode

fiscalCodestring required
fullNamestring required
streetNamestring
civicNumberstring
postalCodestring
citystring
provincestring
regionstring
countrystring
emailstring
phonestring
switchToExpiredboolean required

feature flag to enable the debt position to expire after the due date

companyNamestring required
officeNamestring
validityDatestring date-time
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PARTIALLY_PAID' | 'PAID' | 'REPORTED'

Example response

{
  "payStandIn": true,
  "country": "IT",
  "email": "email@domain.com",
  "paymentOption": [
    {
      "transfer": [
        {
          "organizationFiscalCode": "00000000000",
          "iban": "IT0000000000000000000000000",
          "postalIban": "IT0000000000000000000000000",
          "stamp": {
            "provincialResidence": "RM"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 8 of the 17 revisions of this API.121831

  • a54f9d0b71c66See the full diff
    • ○

      the request optional property paymentOption/items/fee became read-only

      request-optional-property-became-read-only

    • ○

      the payStandIn request property default value changed from true to true

      request-property-default-value-changed

    • ○

      the switchToExpired request property default value changed from false to false

      request-property-default-value-changed

    • ○

      the response optional property paymentOption/items/fee became read-only for the status 201

      response-optional-property-became-read-only

    • ○

      the payStandIn response's property default value changed from true to true for the status 201

      response-property-default-value-changed

    • ○

      the switchToExpired response's property default value changed from false to false for the status 201

      response-property-default-value-changed

  • 228ced2f0bd5696See the full diff
    • ▲

      the request property paymentOption/items/paymentOptionMetadata/items/value became required

      request-property-became-required

    • ▲

      the request property paymentOption/items/transfer/items/transferMetadata/items/value became required

      request-property-became-required

    • ▲

      the paymentOption/items/transfer/items/iban request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the paymentOption/items/transfer/items/postalIban request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      added the pattern ^$|^[A-Za-z0-9]{1,35}$ to the request property paymentOption/items/transfer/items/postalIban

      request-property-pattern-added

    • ▲

      added the pattern ^[A-Za-z0-9]{1,35}$ to the request property paymentOption/items/transfer/items/iban

      request-property-pattern-added

    • ●

      the paymentOption/items/paymentOptionMetadata/items/key request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/paymentOptionMetadata/items/value request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/transfer/items/iban request property's maxLength was set to 35

      request-property-max-length-set

    • ●

      the paymentOption/items/transfer/items/postalIban request property's maxLength was set to 35

      request-property-max-length-set

    • ●

      the paymentOption/items/transfer/items/remittanceInformation request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/transfer/items/transferMetadata/items/key request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/transfer/items/transferMetadata/items/value request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/amount request property's min was set to 1.00

      request-property-min-set

    • ●

      the paymentOption/items/transfer/items/amount request property's min was set to 1.00

      request-property-min-set

    • ○

      the endpoint scheme security Authorization was removed from the API

      api-security-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      the response property paymentOption/items/paymentOptionMetadata/items/value became required for the status 201

      response-property-became-required

    • ○

      the response property paymentOption/items/transfer/items/transferMetadata/items/value became required for the status 201

      response-property-became-required

    • ○

      the paymentOption/items/transfer/items/iban response's property pattern ^[A-Za-z0-9]{1,35}$ was added for the status 201

      response-property-pattern-added

    • ○

      the paymentOption/items/transfer/items/postalIban response's property pattern ^$|^[A-Za-z0-9]{1,35}$ was added for the status 201

      response-property-pattern-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 40898e9a8f8b32See the full diff
    • ●

      the paymentOption/items/transfer/items/stamp/hashDocument request property's maxLength was set to 72

      request-property-max-length-set

    • ●

      removed the request property aca

      request-property-removed

    • ●

      removed the optional property aca from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property paymentOption/items/transfer/items/companyName

      new-optional-request-property

    • ○

      added the optional property paymentOption/items/transfer/items/companyName to the response with the 201 status

      response-optional-property-added

  • 6b0bf977aa31131See the full diff
    • ▲

      the request property paymentOption/items/description became required

      request-property-became-required

    • ●

      the companyName request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the officeName request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/description request property's maxLength was set to 140

      request-property-max-length-set

    • ○

      the response property paymentOption/items/description became required for the status 201

      response-property-became-required

  • cb518d74c6014See the full diff
    • ○

      the aca request property default value false was added

      request-property-default-value-added

    • ○

      the payStandIn request property default value true was added

      request-property-default-value-added

    • ○

      the aca response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the payStandIn response's property default value true was added for the status 201

      response-property-default-value-added

  • 4932550bd41b45See the full diff
    • ▲

      the response property paymentOption/items/description became optional for the status 201

      response-property-became-optional

    • ▲

      the companyName response property's maxLength was unset from 140 for the response status 201

      response-property-max-length-unset

    • ▲

      the officeName response property's maxLength was unset from 140 for the response status 201

      response-property-max-length-unset

    • ▲

      the paymentOption/items/description response property's maxLength was unset from 140 for the response status 201

      response-property-max-length-unset

    • ○

      added the new optional request property aca

      new-optional-request-property

    • ○

      the request property paymentOption/items/description became optional

      request-property-became-optional

    • ○

      the payStandIn request property default value true was removed

      request-property-default-value-removed

    • ○

      added the optional property aca to the response with the 201 status

      response-optional-property-added

    • ○

      the payStandIn response's property default value true was removed for the status 201

      response-property-default-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c8b7b4d7adc133See the full diff
    • ▲

      the request property paymentOption/items/description became required

      request-property-became-required

    • ●

      the companyName request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the officeName request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the paymentOption/items/description request property's maxLength was set to 140

      request-property-max-length-set

    • ○

      added the new optional request property payStandIn

      new-optional-request-property

    • ○

      added the optional property payStandIn to the response with the 201 status

      response-optional-property-added

    • ○

      the response property paymentOption/items/description became required for the status 201

      response-property-became-required

  • ce68c38c9d454See the full diff
    • ○

      the request optional property paymentOption/items/nav became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property switchToExpired with a default value became required

      request-property-became-required-with-default

    • ○

      the response optional property paymentOption/items/nav became not read-only for the status 201

      response-optional-property-became-not-read-only

    • ○

      the response property switchToExpired became required for the status 201

      response-property-became-required