Sign in
Debt Positions API

The Organization updates a debt position

put/organizations/{organizationfiscalcode}/debtpositions/{iupd}

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

iupdstring required

IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.

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

Debt Position updated.

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 // became read-only

      request-optional-property-became-read-only

    • ○

      the request property default value changed from true to true

      request-property-default-value-changed

    • ○

      the request property default value changed from false to false

      request-property-default-value-changed

    • ○

      the response optional property // became read-only for the status

      response-optional-property-became-read-only

    • ○

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

      response-property-default-value-changed

    • ○

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

      response-property-default-value-changed

  • 228ced2f0bd5696See the full diff
    • ▲

      the request property //// became required

      request-property-became-required

    • ▲

      the request property ////// became required

      request-property-became-required

    • ▲

      the //// request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the //// 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 ////

      request-property-pattern-added

    • ▲

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

      request-property-pattern-added

    • ●

      the //// request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the //// request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the //// request property's maxLength was set to 35

      request-property-max-length-set

    • ●

      the //// request property's maxLength was set to 35

      request-property-max-length-set

    • ●

      the //// request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the ////// request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the ////// request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the // request property's min was set to 1.00

      request-property-min-set

    • ●

      the //// 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

      response-non-success-status-added

    • ○

      the response property //// became required for the status

      response-property-became-required

    • ○

      the response property ////// became required for the status

      response-property-became-required

    • ○

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

      response-property-pattern-added

    • ○

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

      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 ///// request property's maxLength was set to 72

      request-property-max-length-set

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • 6b0bf977aa31131See the full diff
    • ▲

      the request property // became required

      request-property-became-required

    • ●

      the request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 140

      request-property-max-length-set

    • ○

      the response property // became required for the status

      response-property-became-required

  • cb518d74c6014See the full diff
    • ○

      the request property default value false was added

      request-property-default-value-added

    • ○

      the request property default value true was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

  • 4932550bd41b45See the full diff
    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

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

      response-property-max-length-unset

    • ▲

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

      response-property-max-length-unset

    • ▲

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

      response-property-max-length-unset

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property // became optional

      request-property-became-optional

    • ○

      the request property default value true was removed

      request-property-default-value-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

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

      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 // became required

      request-property-became-required

    • ●

      the request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 140

      request-property-max-length-set

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      the response property // became required for the status

      response-property-became-required

  • ce68c38c9d454See the full diff
    • ○

      the request optional property // became not read-only

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

    • ○

      the request property with a default value became required

      request-property-became-required-with-default

    • ○

      the response optional property // became not read-only for the status

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

    • ○

      the response property became required for the status

      response-property-became-required