Debt Positions API: Installments and Payment Options Manager

Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.

Changed on

Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.

get/organizations/{organizationfiscalcode}/debtpositions

Request

  • Base URL: https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3
  • URL: https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/organizations/{organizationfiscalcode}/debtpositions
  • Auth: one of:
    • API key in header Ocp-Apim-Subscription-Key
    • API key in query parameter subscription-key

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

Query parameters

limitinteger

Number of elements on one page. Default = 50

pageinteger

Page number. Page value starts from 0

due_date_fromstring date

Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to.

due_date_tostring date

Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from.

payment_date_fromstring date

Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to.

payment_date_tostring date

Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from

payment_date_time_fromstring date-time

Filter from payment_date_time (if provided use the format yyyy-MM-ddTHH:mm:ss). If not provided will be set to 30 days before the payment_date_time_from.

payment_date_time_tostring date-time

Filter to payment_date_time (if provided use the format yyyy-MM-ddTHH:mm:ss). If not will be set to 30 days after the payment_date_time_to.

status'DRAFT' | 'PUBLISHED' | 'VALID' | 'UNPAYABLE' | 'PARTIALLY_PAID' | 'PAID'

Filter by debt position status

orderby'INSERTED_DATE' | 'IUPD' | 'STATUS' | 'COMPANY_NAME'

Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS

ordering'ASC' | 'DESC'

Direction of ordering

Headers

X-Request-Idstring

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Response

Obtained all organization payment positions.

Changes

  • v36f3db9e68367Revision changes
    • info

      the endpoint scheme security ApiKey was removed from the API

    • info

      added the new optional header request parameter X-Request-Id

    • info

      added the new optional query request parameter payment_date_time_from

    • info

      added the new optional query request parameter payment_date_time_to

  • v393e168e2fe0eRevision changes
    • warning

      deleted the header request parameter X-Request-Id

    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      added the new optional header request parameter X-Request-Id to all path's operations