Skip to main content

Get Account Claims Use Case

Get Account Claims with Pagination and Limit

To fetch a claim which will be paginated and have limit param, you will need to send a GET request to the following URL: https://api.receeve-demo.com/v1/get_account_claims

This API has two URI params in it which as below:

  • accountReference(mandatory) : Add the Account reference for which you want to fetch the respective claims
  • limit(optional) : This param is to pass the limit to fetch the claims if you want to see specific number of claims in an account.

Be sure to include the Authorization header with the Bearer authentication scheme and the access_token as the credentials. The access_token is provided by the authentication request.

This API can be used in two ways:

  1. You can fetch the records by ONLY passing the account_reference as a param(which is mandatory) and it will return you all the associated claims for it.

Below is an example:

Let’s assume that you expect an account “ALLAVIN_ACCOUNT_0127“ has 5 claims in it. You can fetch all the associated claims from the system by simply sending the following request:

GET /v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_account_claims?accountReference=ALLAVIN_ACCOUNT_0127 HTTP/1.1
Host: api.receeve-demo.com
Content-Type: application/json
Authorization: {{access_token}}

Notes:

  • The 3d132b18-6b6f-4f7c-b464-6a8ee7ca5235 is the Client Instance ID for your account. This is provided by receeve together with the credentials for the API.
  • The accountReference is a unique identifier and a mandatory param which represents the Account of the debtor with single or multiple claims associated with it.

The response will be a JSON object with the following structure:

[
  {
    "claimReference": "CLAIM_0127-002",
    "status": "RESOLVED",
    "meta": {
      "isFromQA": true,
      "accountId": "ALLAVIN_ACCOUNT_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "__accountMetaFields__": ["contact", "isFromQA"],
      "contact": {
        "id": "1212-21"
      },
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "__claimMetaFields__": [
        "accountId",
        "accountNumber",
        "accountReference",
        "isFromQA"
      ]
    },
    "fees": [
      {
        "name": "Fees",
        "amount": 111100
      }
    ],
    "amount": 1355500,
    "currency": "EUR",
    "productReference": "Mercedes-benz",
    "paymentReference": "BestClient_PaymentReference-1",
    "accountReference": "ALLAVIN_ACCOUNT_0127",
    "currentDueDate": "2021-11-08",
    "accountNumber": "ALLAVIN_ACCOUNT_0127",
    "primaryDebtor": {
      "type": "natural",
      "title": "Doctor",
      "gender": "F",
      "birthday": "1988-05-27",
      "lastName": "Green",
      "firstName": "Polinar",
      "middleName": "Benedict",
      "companyName": "Acme Brick Co.",
      "contactInformation": {
        "country": "DE",
        "additionalAddresses": [],
        "city": "Delbrück",
        "mobileNumber": "+495555555555",
        "postalCode": "33123",
        "addressLine1": "Boikweg 24",
        "landLine": "+495555555555",
        "addressLine2": "c/o Acme",
        "state": "Dortmund",
        "addressLine3": "additional information",
        "email": "james.bond@indebted.co"
      },
      "debtorReference": "string"
    },
    "portfolioReference": "TheBestClientEver",
    "originalDueDate": "2021-10-22",
    "totalFees": 111100
  },
  {
    "claimReference": "CLAIM_0127-001",
    "status": "RESOLVED",
    "meta": {
      "isFromQA": true,
      "accountId": "ALLAVIN_ACCOUNT_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "__accountMetaFields__": ["contact", "isFromQA"],
      "contact": {
        "id": "1212-21"
      },
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "__claimMetaFields__": [
        "accountId",
        "accountNumber",
        "accountReference",
        "isFromQA"
      ]
    },
    "fees": [
      {
        "name": "Fees",
        "amount": 11100
      }
    ],
    "amount": 355500,
    "currency": "EUR",
    "productReference": "November11-001",
    "paymentReference": "BestClient_PaymentReference-1",
    "accountReference": "ALLAVIN_ACCOUNT_0127",
    "currentDueDate": "2021-11-08",
    "accountNumber": "ALLAVIN_ACCOUNT_0127",
    "primaryDebtor": {
      "type": "natural",
      "title": "Doctor",
      "gender": "F",
      "birthday": "1988-05-27",
      "lastName": "Green",
      "firstName": "Polinar",
      "middleName": "Benedict",
      "companyName": "Acme Brick Co.",
      "contactInformation": {
        "country": "DE",
        "additionalAddresses": [],
        "city": "Delbrück",
        "mobileNumber": "+495555555555",
        "postalCode": "33123",
        "addressLine1": "Boikweg 24",
        "landLine": "+495555555555",
        "addressLine2": "c/o Acme",
        "state": "Dortmund",
        "addressLine3": "additional information",
        "email": "james.bond@indebted.co"
      },
      "debtorReference": "string"
    },
    "portfolioReference": "TheBestClientEver",
    "originalDueDate": "2021-10-22",
    "totalFees": 11100
  },
  {
    "claimReference": "028ff437-766b-43c4-bca8-ee1289ea06c0",
    "status": "ACTIVE",
    "meta": {
      "isFromQA": true,
      "__accountMetaFields__": ["contact", "isFromQA"],
      "productCode": "PRL",
      "outstandingInvoices": [
        {
          "context": {
            "productReference": "ALLAVIN_PRODUCT_REF_0127"
          },
          "invoiceDetails": {
            "createdAt": 1636624831143,
            "amount": 305000,
            "meta": {
              "isFromQA": true,
              "contact": {
                "id": "1212-21"
              }
            },
            "dueDate": "2021-10-20"
          },
          "type": "invoice",
          "ledgerEntryReference": "ALLAVIN_LEDGERENTRY_REF_0127"
        }
      ],
      "claim_status": "Old",
      "Alphanumeric": "TSET",
      "contact": {
        "id": "1212-21"
      },
      "isFromManoj": "Dead",
      "__productMetaFields__": [],
      "outstandingClaimReferences": [
        "ALLAVIN_ACCOUNT_0127-ALLAVIN_LEDGERENTRY_REF_0127"
      ],
      "__claimMetaFields__": [
        "Alphanumeric",
        "claim_status",
        "contact",
        "isFromManoj",
        "isFromQA",
        "outstandingClaimReferences",
        "outstandingInvoices",
        "productCode"
      ],
      "accountId": "ALLAVIN_ACCOUNT_0127",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127"
    },
    "fees": [],
    "amount": 51850,
    "currency": "EUR",
    "accountReference": "ALLAVIN_ACCOUNT_0127",
    "currentDueDate": "2021-10-20",
    "accountNumber": "ALLAVIN_ACCOUNT_0127",
    "primaryDebtor": {
      "type": "natural",
      "title": "Doctor",
      "gender": "F",
      "birthday": "1988-05-27",
      "lastName": "Green",
      "firstName": "Polinar",
      "middleName": "Benedict",
      "companyName": "Acme Brick Co.",
      "contactInformation": {
        "country": "DE",
        "additionalAddresses": [],
        "city": "Delbrück",
        "mobileNumber": "+495555555555",
        "postalCode": "33123",
        "addressLine1": "Boikweg 24",
        "landLine": "+495555555555",
        "addressLine2": "c/o Acme",
        "state": "Dortmund",
        "addressLine3": "additional information",
        "email": "james.bond@indebted.co"
      },
      "debtorReference": "string"
    },
    "originalDueDate": "2021-10-20",
    "totalFees": 0
  },
  {
    "claimReference": "CLAIM_0127-003",
    "status": "RESOLVED",
    "meta": {
      "isFromQA": true,
      "accountId": "ALLAVIN_ACCOUNT_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "__accountMetaFields__": ["contact", "isFromQA"],
      "contact": {
        "id": "1212-21"
      },
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "__claimMetaFields__": [
        "accountId",
        "accountNumber",
        "accountReference",
        "isFromQA"
      ]
    },
    "fees": [
      {
        "name": "Fees",
        "amount": 0
      }
    ],
    "amount": 22200,
    "currency": "EUR",
    "productReference": "Mercedes-benz",
    "paymentReference": "BestClient_PaymentReference-1",
    "accountReference": "ALLAVIN_ACCOUNT_0127",
    "currentDueDate": "2021-10-03",
    "accountNumber": "ALLAVIN_ACCOUNT_0127",
    "primaryDebtor": {
      "type": "natural",
      "title": "Doctor",
      "gender": "F",
      "birthday": "1988-05-27",
      "lastName": "Green",
      "firstName": "Polinar",
      "middleName": "Benedict",
      "companyName": "Acme Brick Co.",
      "contactInformation": {
        "country": "DE",
        "additionalAddresses": [],
        "city": "Delbrück",
        "mobileNumber": "+495555555555",
        "postalCode": "33123",
        "addressLine1": "Boikweg 24",
        "landLine": "+495555555555",
        "addressLine2": "c/o Acme",
        "state": "Dortmund",
        "addressLine3": "additional information",
        "email": "james.bond@indebted.co"
      },
      "debtorReference": "string"
    },
    "portfolioReference": "TheBestClientEver",
    "originalDueDate": "2021-10-22",
    "totalFees": 0
  },
  {
    "claimReference": "ALLAVIN_ACCOUNT_0127-ALLAVIN_LEDGERENTRY_REF_0127",
    "status": "RESOLVED",
    "meta": {
      "isFromQA": true,
      "__invoiceLedgerEntry__": {
        "context": {
          "productReference": "ALLAVIN_PRODUCT_REF_0127"
        },
        "invoiceDetails": {
          "createdAt": 1636624831143,
          "amount": 305000,
          "meta": {
            "isFromQA": true,
            "contact": {
              "id": "1212-21"
            }
          },
          "dueDate": "2021-10-20"
        },
        "type": "invoice",
        "ledgerEntryReference": "ALLAVIN_LEDGERENTRY_REF_0127"
      },
      "__accountMetaFields__": ["contact", "isFromQA"],
      "__claimMetaFields__": ["__invoiceLedgerEntry__"],
      "contact": {
        "id": "1212-21"
      },
      "accountId": "ALLAVIN_ACCOUNT_0127",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127"
    },
    "fees": [],
    "amount": 305000,
    "currency": "EUR",
    "productReference": "ALLAVIN_PRODUCT_REF_0127",
    "accountReference": "ALLAVIN_ACCOUNT_0127",
    "currentDueDate": "2021-11-25",
    "accountNumber": "ALLAVIN_ACCOUNT_0127",
    "primaryDebtor": {
      "type": "natural",
      "title": "Doctor",
      "gender": "F",
      "birthday": "1988-05-27",
      "lastName": "Green",
      "firstName": "Polinar",
      "middleName": "Benedict",
      "companyName": "Acme Brick Co.",
      "contactInformation": {
        "country": "DE",
        "additionalAddresses": [],
        "city": "Delbrück",
        "mobileNumber": "+495555555555",
        "postalCode": "33123",
        "addressLine1": "Boikweg 24",
        "landLine": "+495555555555",
        "addressLine2": "c/o Acme",
        "state": "Dortmund",
        "addressLine3": "additional information",
        "email": "james.bond@indebted.co"
      },
      "debtorReference": "string"
    },
    "originalDueDate": "2021-10-20",
    "totalFees": 0
  }
]

Notes

  • The 3d132b18-6b6f-4f7c-b464-6a8ee7ca5235 is the Client Instance ID for your account. This is provided by receeve together with the credentials for the API.
  • The status must be a valid status within receeve system.
  • The amount and the fees (or any monetary value) must be expressed in cents. For example, 1111 euros must be expressed as 111100 cents.
  • The claimReference key is the claim reference. It can be any string, but it must be unique for each claim.
  • The meta information of the claims which includes accountID,accountReference,accountNumber ... etc.
  • The currentDueDate and originalDueDate are required and must be in the format YYYY-MM-DD.
  • The originalDueDate is the claim’s original due date in your system. This is the day when it went past due.
  • The debtorReference is the debtor’s unique identifier. It can be any string, but it must be unique for each debtor.
  • The productReference is the unique identifier. It can be any string, but it must be unique for each claim.
  • The currentDueDate is the claim’s current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
  • The response can include multiple claims and will also contain the status of each claim.
  1. You can fetch the records by passing the account_reference as a param(which is mandatory) and limit param it will return you all the associated claims for it in a paginated manner.
GET /v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_account_claims?accountReference=ALLAVIN_ACCOUNT_0127&limit=2 HTTP/1.1
Host: api.receeve-demo.com
Content-Type: application/json
Authorization: {{access_token}}

Notes:

  • The 3d132b18-6b6f-4f7c-b464-6a8ee7ca5235 is the Client Instance ID for your account. This is provided by receeve together with the credentials for the API.
  • The accountReference is a unique identifier and a mandatory param which represents the Account of the debtor with single or multiple claims associated with it.
  • The limit is a number value which is optional param to fetch the limited number of claims associated with the referred account.

The response will be a JSON object with the following structure:

{
  "results": [
    {
      "claimReference": "CLAIM_0127-002",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127",
        "__accountMetaFields__": ["contact", "isFromQA"],
        "contact": {
          "id": "1212-21"
        },
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "__claimMetaFields__": [
          "accountId",
          "accountNumber",
          "accountReference",
          "isFromQA"
        ]
      },
      "fees": [
        {
          "name": "Fees",
          "amount": 111100
        }
      ],
      "amount": 1355500,
      "currency": "EUR",
      "productReference": "Mercedes-benz",
      "paymentReference": "BestClient_PaymentReference-1",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-11-08",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "portfolioReference": "TheBestClientEver",
      "originalDueDate": "2021-10-22",
      "totalFees": 111100
    },
    {
      "claimReference": "CLAIM_0127-001",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127",
        "__accountMetaFields__": ["contact", "isFromQA"],
        "contact": {
          "id": "1212-21"
        },
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "__claimMetaFields__": [
          "accountId",
          "accountNumber",
          "accountReference",
          "isFromQA"
        ]
      },
      "fees": [
        {
          "name": "Fees",
          "amount": 11100
        }
      ],
      "amount": 355500,
      "currency": "EUR",
      "productReference": "November11-001",
      "paymentReference": "BestClient_PaymentReference-1",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-11-08",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "portfolioReference": "TheBestClientEver",
      "originalDueDate": "2021-10-22",
      "totalFees": 11100
    }
  ],
  "paginationId": "eyJhY2NvdW50SWQiOiJBTExBVklOX0FDQ09VTlRfMDEyNyIsImNsaWVudElkIjoiM2QxMzJiMTgtNmI2Zi00ZjdjLWI0NjQtNmE4ZWU3Y2E1MjM1IiwiZXh0ZXJuYWxDbGFpbVJlZiI6IkNMQUlNXzAxMjctMDAxIn0="
}

Now, if we pass limit as limit=3 in the param, In response it will return three claims on from page 2 and 3 records from the table with the paginationId for the next record in the row.

GET /v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_account_claims?accountReference=ALLAVIN_ACCOUNT_0127&limit=3 HTTP/1.1
Host: api.receeve-demo.com
Content-Type: application/json
Authorization: {{access_token}}

The response will be a JSON object with the following structure:

{
  "results": [
    {
      "claimReference": "CLAIM_0127-002",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127",
        "__accountMetaFields__": ["contact", "isFromQA"],
        "contact": {
          "id": "1212-21"
        },
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "__claimMetaFields__": [
          "accountId",
          "accountNumber",
          "accountReference",
          "isFromQA"
        ]
      },
      "fees": [
        {
          "name": "Fees",
          "amount": 111100
        }
      ],
      "amount": 1355500,
      "currency": "EUR",
      "productReference": "Mercedes-benz",
      "paymentReference": "BestClient_PaymentReference-1",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-11-08",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "portfolioReference": "TheBestClientEver",
      "originalDueDate": "2021-10-22",
      "totalFees": 111100
    },
    {
      "claimReference": "CLAIM_0127-001",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127",
        "__accountMetaFields__": ["contact", "isFromQA"],
        "contact": {
          "id": "1212-21"
        },
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "__claimMetaFields__": [
          "accountId",
          "accountNumber",
          "accountReference",
          "isFromQA"
        ]
      },
      "fees": [
        {
          "name": "Fees",
          "amount": 11100
        }
      ],
      "amount": 355500,
      "currency": "EUR",
      "productReference": "November11-001",
      "paymentReference": "BestClient_PaymentReference-1",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-11-08",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "portfolioReference": "TheBestClientEver",
      "originalDueDate": "2021-10-22",
      "totalFees": 11100
    },
    {
      "claimReference": "028ff437-766b-43c4-bca8-ee1289ea06c0",
      "status": "ACTIVE",
      "meta": {
        "isFromQA": true,
        "__accountMetaFields__": ["contact", "isFromQA"],
        "productCode": "PRL",
        "outstandingInvoices": [
          {
            "context": {
              "productReference": "ALLAVIN_PRODUCT_REF_0127"
            },
            "invoiceDetails": {
              "createdAt": 1636624831143,
              "amount": 305000,
              "meta": {
                "isFromQA": true,
                "contact": {
                  "id": "1212-21"
                }
              },
              "dueDate": "2021-10-20"
            },
            "type": "invoice",
            "ledgerEntryReference": "ALLAVIN_LEDGERENTRY_REF_0127"
          }
        ],
        "claim_status": "Old",
        "Alphanumeric": "TSET",
        "contact": {
          "id": "1212-21"
        },
        "isFromManoj": "Dead",
        "__productMetaFields__": [],
        "outstandingClaimReferences": [
          "ALLAVIN_ACCOUNT_0127-ALLAVIN_LEDGERENTRY_REF_0127"
        ],
        "__claimMetaFields__": [
          "Alphanumeric",
          "claim_status",
          "contact",
          "isFromManoj",
          "isFromQA",
          "outstandingClaimReferences",
          "outstandingInvoices",
          "productCode"
        ],
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127"
      },
      "fees": [],
      "amount": 51850,
      "currency": "EUR",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-10-20",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "originalDueDate": "2021-10-20",
      "totalFees": 0
    }
  ],
  "paginationId": "eyJhY2NvdW50SWQiOiJBTExBVklOX0FDQ09VTlRfMDEyNyIsImNsaWVudElkIjoiM2QxMzJiMTgtNmI2Zi00ZjdjLWI0NjQtNmE4ZWU3Y2E1MjM1IiwiZXh0ZXJuYWxDbGFpbVJlZiI6IjAyOGZmNDM3LTc2NmItNDNjNC1iY2E4LWVlMTI4OWVhMDZjMCJ9"
}

Now, what if we pass limit=3 and paginationId received from response, then it will only return all the records from the page 2 of table and return the paginationId as NULL because there will be no more records available in the page 2 of table.Let’s see this as an example below:

NOTE: claimRef = “028ff437-766b-43c4-bca8-ee1289ea06c0“ will not be returned because it is on page 3 in a row. (Check above response for your reference).

GET /v1/3d132b18-6b6f-4f7c-b464-6a8ee7ca5235/get_account_claims?accountReference=ALLAVIN_ACCOUNT_0127&limit=3&paginationId=eyJhY2NvdW50SWQiOiJBTExBVklOX0FDQ09VTlRfMDEyNyIsImNsaWVudElkIjoiM2QxMzJiMTgtNmI2Zi00ZjdjLWI0NjQtNmE4ZWU3Y2E1MjM1IiwiZXh0ZXJuYWxDbGFpbVJlZiI6IjAyOGZmNDM3LTc2NmItNDNjNC1iY2E4LWVlMTI4OWVhMDZjMCJ9 HTTP/1.1
Host: api.receeve-demo.com
Content-Type: application/json
Authorization: {{access_token}}

The response will be a JSON object with the following structure:

{
  "results": [
    {
      "claimReference": "CLAIM_0127-003",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127",
        "__accountMetaFields__": ["contact", "isFromQA"],
        "contact": {
          "id": "1212-21"
        },
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "__claimMetaFields__": [
          "accountId",
          "accountNumber",
          "accountReference",
          "isFromQA"
        ]
      },
      "fees": [
        {
          "name": "Fees",
          "amount": 0
        }
      ],
      "amount": 22200,
      "currency": "EUR",
      "productReference": "Mercedes-benz",
      "paymentReference": "BestClient_PaymentReference-1",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-10-03",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "portfolioReference": "TheBestClientEver",
      "originalDueDate": "2021-10-22",
      "totalFees": 0
    },
    {
      "claimReference": "ALLAVIN_ACCOUNT_0127-ALLAVIN_LEDGERENTRY_REF_0127",
      "status": "RESOLVED",
      "meta": {
        "isFromQA": true,
        "__invoiceLedgerEntry__": {
          "context": {
            "productReference": "ALLAVIN_PRODUCT_REF_0127"
          },
          "invoiceDetails": {
            "createdAt": 1636624831143,
            "amount": 305000,
            "meta": {
              "isFromQA": true,
              "contact": {
                "id": "1212-21"
              }
            },
            "dueDate": "2021-10-20"
          },
          "type": "invoice",
          "ledgerEntryReference": "ALLAVIN_LEDGERENTRY_REF_0127"
        },
        "__accountMetaFields__": ["contact", "isFromQA"],
        "__claimMetaFields__": ["__invoiceLedgerEntry__"],
        "contact": {
          "id": "1212-21"
        },
        "accountId": "ALLAVIN_ACCOUNT_0127",
        "accountNumber": "ALLAVIN_ACCOUNT_0127",
        "accountReference": "ALLAVIN_ACCOUNT_0127"
      },
      "fees": [],
      "amount": 305000,
      "currency": "EUR",
      "productReference": "ALLAVIN_PRODUCT_REF_0127",
      "accountReference": "ALLAVIN_ACCOUNT_0127",
      "currentDueDate": "2021-11-25",
      "accountNumber": "ALLAVIN_ACCOUNT_0127",
      "primaryDebtor": {
        "type": "natural",
        "title": "Doctor",
        "gender": "F",
        "birthday": "1988-05-27",
        "lastName": "Green",
        "firstName": "Polinar",
        "middleName": "Benedict",
        "companyName": "Acme Brick Co.",
        "contactInformation": {
          "country": "DE",
          "additionalAddresses": [],
          "city": "Delbrück",
          "mobileNumber": "+495555555555",
          "postalCode": "33123",
          "addressLine1": "Boikweg 24",
          "landLine": "+495555555555",
          "addressLine2": "c/o Acme",
          "state": "Dortmund",
          "addressLine3": "additional information",
          "email": "james.bond@indebted.co"
        },
        "debtorReference": "string"
      },
      "originalDueDate": "2021-10-20",
      "totalFees": 0
    }
  ],
  "paginationId": null
}

Notes:

  • The 3d132b18-6b6f-4f7c-b464-6a8ee7ca5235 is the Client Instance ID for your account. This is provided by receeve together with the credentials for the API.
  • The results is an array of objects which returns with the limited number of claims in it.
  • The paginationId is a BASE64 string(combination of clientID + accountReference + claim reference) which is returned if more claims are present in the table for an account Reference and it is returned as null if there are no more claims are present in the table.
  • The status must be a valid status within receeve system.
  • The amount and the fees (or any monetary value) must be expressed in cents. For example, 1111 euros must be expressed as 111100 cents.
  • The claimReference key is the claim reference. It can be any string, but it must be unique for each claim.
  • The meta information of the claims which includes accountID,accountReference,accountNumber ... etc.
  • The currentDueDate and originalDueDate are required and must be in the format YYYY-MM-DD.
  • The originalDueDate is the claim’s original due date in your system. This is the day when it went past due.
  • The debtorReference is the debtor’s unique identifier. It can be any string, but it must be unique for each debtor.
  • The productReference is the unique identifier. It can be any string, but it must be unique for each claim.
  • The currentDueDate is the claim’s current due date in your system. Use originalDueDate unless you purchased the debt and need this distinction.
  • The response can include multiple claims and will also contain the status of each claim.
  • Here,

FAQ

  • How do I get an Access Token? You can get an Access Token using the process outlined in the Authentication Use Case document.
  • Is there a hard limit on the number of claims that I can fetch at once? Yes, there are hard limits to consider. First, the claims’ total size cannot exceed 200 Kb max (including the metadata). Second, the limit should always be greater than 0 (limit > 0)and can or should be provided as an optional parameter in the API call.
  • How do we know when they fetched all the claims from the account when using the paginationId**?** When we pass the limit in the params it returns the respective number of claims in response with BASE 64 string as a value for paginationId (which means there are still records available for the referred account). When there is again a new request with the increased value for limit, it returns a response with all the claims in it but the paginationId as null. So from there, it is CONFIRMED that there are no more records available to be fetched for the given accountReference.