Filter movement

POST/movement/filter

Returns a list of movements.

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/movement/filter?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "initialValue": 0,
  "endValue": 10,
  "subject": "",
  "description": "",
  "hash": "",
  "originType": "payment",
  "referenceId": "",
  "groupId": "",
  "initialDate": "",
  "endDate": "",
  "omitDebit": false,
  "omitCredit": false
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/movement/filter?page=1&limit=10', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "initialValue": 0,
    "endValue": 10,
    "subject": "",
    "description": "",
    "hash": "",
    "originType": "payment",
    "referenceId": "",
    "groupId": "",
    "initialDate": "",
    "endDate": "",
    "omitDebit": false,
    "omitCredit": false
  }),
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/movement/filter?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}
payload = {
    "initialValue": 0,
    "endValue": 10,
    "subject": "",
    "description": "",
    "hash": "",
    "originType": "payment",
    "referenceId": "",
    "groupId": "",
    "initialDate": "",
    "endDate": "",
    "omitDebit": False,
    "omitCredit": False,
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "movements": {
      "docs": [
        {
          "id": "652b4d6f8b0d2f4b6d8f0066",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": -250,
          "subject": "Taxa de Reembolso",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4Om91dGNvbWU6MjUwOkZyaSBGZWIgMTQgMjAyNSAxNDo0NToxNyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6OWUxYTNjNWUtN2E5Yy00ZTNhLThjN2UtOWExYzNlNWEwMDA5",
          "originType": "refund-tax",
          "ocurredAt": "2025-02-14T17:45:17.538Z",
          "groupId": "653c5e7a9c1e3a5c7e9a0067"
        },
        {
          "id": "654d6f8b0d2f4b6d8f0b0068",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": 250,
          "subject": "Devolução de reserva de saldo",
          "hash": "MWMzZTVhN2MtOWUxYS00YzVlLThhOWMtMWUzYTVjN2UwMDAxOnByb21pc3Nvcnk6MjAyNS0wMi0xNFQxNzo0NToxNS4zMTBaOjI1MA==",
          "originType": "promissory",
          "referenceId": "655e7a9c1e3a5c7e9a1c0069",
          "ocurredAt": "2025-02-14T17:45:15.310Z",
          "groupId": "653c5e7a9c1e3a5c7e9a0067"
        },
        {
          "id": "656f8b0d2f4b6d8f0b2d006a",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": -250,
          "subject": "Reserva de saldo",
          "hash": "MWMzZTVhN2MtOWUxYS00YzVlLThhOWMtMWUzYTVjN2UwMDAxOnByb21pc3Nvcnk6MjAyNS0wMi0xNFQxNzo0NToxNS4zMTBaOi0yNTA=",
          "originType": "promissory",
          "referenceId": "655e7a9c1e3a5c7e9a1c0069",
          "ocurredAt": "2025-02-14T17:45:15.310Z",
          "groupId": "653c5e7a9c1e3a5c7e9a0067"
        },
        {
          "id": "657a9c1e3a5c7e9a1c3e006b",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": -250,
          "subject": "Taxa de Reembolso",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4Om91dGNvbWU6MjUwOlRodSBKYW4gMzAgMjAyNSAxMzozODo1MiBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6MGYyYjRkNmYtOGIwZC00ZjRiLThkOGYtMGIyZDRmNmIwMDBh",
          "originType": "refund-tax",
          "ocurredAt": "2025-01-30T16:38:52.143Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "659c1e3a5c7e9a1c3e5a006d",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": -1250,
          "subject": "Reembolso",
          "description": "Id da venda 4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0004",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4Om91dGNvbWU6MTI1MDpUaHUgSmFuIDMwIDIwMjUgMTM6Mzg6NTAgR01ULTAzMDAgKEJyYXNpbGlhIFN0YW5kYXJkIFRpbWUpOjFhM2M1ZTdhLTljMWUtNGE1Yy04ZTlhLTFjM2U1YTdjMDAwYg==",
          "originType": "payment",
          "referenceId": "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0005",
          "ocurredAt": "2025-01-30T16:38:50.660Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "650d2f4b6d8f0b2d4f6b006e",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": 250,
          "subject": "Devolução de reserva de saldo",
          "hash": "MWMzZTVhN2MtOWUxYS00YzVlLThhOWMtMWUzYTVjN2UwMDAxOnByb21pc3Nvcnk6MjAyNS0wMS0zMFQxNjozODo1MC4yNzlaOjI1MA==",
          "originType": "promissory",
          "referenceId": "651e3a5c7e9a1c3e5a7c006f",
          "ocurredAt": "2025-01-30T16:38:50.279Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "652f4b6d8f0b2d4f6b8d0070",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": -250,
          "subject": "Reserva de saldo",
          "hash": "MWMzZTVhN2MtOWUxYS00YzVlLThhOWMtMWUzYTVjN2UwMDAxOnByb21pc3Nvcnk6MjAyNS0wMS0zMFQxNjozODo1MC4yNzlaOi0yNTA=",
          "originType": "promissory",
          "referenceId": "651e3a5c7e9a1c3e5a7c006f",
          "ocurredAt": "2025-01-30T16:38:50.279Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "653a5c7e9a1c3e5a7c9e0071",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": 1250,
          "subject": "Comissão de venda",
          "description": "Id da venda 4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0004",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4OmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMzowMDowMyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6MmI0ZDZmOGItMGQyZi00YjZkLThmMGItMmQ0ZjZiOGQwMDBj",
          "originType": "payment",
          "referenceId": "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0005",
          "ocurredAt": "2025-01-30T16:00:03.059Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "654b6d8f0b2d4f6b8d0f0072",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": 1250,
          "subject": "Comissão de venda",
          "description": "Id da venda 4f6b8d0f-2b4d-4f8b-8d2f-4b6d8f0b0004",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4OmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMjoxODo1NyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6M2M1ZTdhOWMtMWUzYS00YzdlLThhMWMtM2U1YTdjOWUwMDBk",
          "originType": "payment",
          "referenceId": "5a7c9e1a-3c5e-4a9c-8e3a-5c7e9a1c0005",
          "ocurredAt": "2025-01-30T15:18:57.508Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        },
        {
          "id": "655c7e9a1c3e5a7c9e1a0073",
          "businessIds": [
            "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001"
          ],
          "valueInCents": 1250,
          "subject": "Comissão de venda",
          "description": "Id da venda 6b8d0f2b-4d6f-4b0d-8f4b-6d8f0b2d0006",
          "hash": "OGQwZjJiNGQtNmY4Yi00ZDJmLThiNmQtOGYwYjJkNGYwMDA4OmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMjowNzoxNCBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6NGQ2ZjhiMGQtMmY0Yi00ZDhmLThiMmQtNGY2YjhkMGYwMDBl",
          "originType": "payment",
          "referenceId": "7c9e1a3c-5e7a-4c1e-8a5c-7e9a1c3e0007",
          "ocurredAt": "2025-01-30T15:07:14.672Z",
          "groupId": "658b0d2f4b6d8f0b2d4f006c"
        }
      ],
      "currentPage": 1,
      "hasNext": true,
      "limit": 10,
      "nextPage": 2,
      "totalDocs": 86,
      "totalPages": 9
    },
    "count": 86,
    "totalValue": 10265
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Query parameters

pageintegerrequired
Page number to access

Example:1
limitintegerrequired
Number of items to be loaded per page

Example:10

Request body

Optional Fields for movements Filtering

Content typeapplication/jsonobject

initialValueinteger
endValueinteger
subjectstring
descriptionstring
hashstring
originTypestring
Possible values:paymentdepositwithdraw-requesttransfer-requestwithdraw-feeanticipation-taxrefund-taxrefund-shortfallexternal-liquidationpromissoryother
referenceIdstring
groupIdstring
initialDatestring
endDatestring
omitDebitboolean
omitCreditboolean

Responses

200Returns a list of movements.

Returns a list of movements.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- movementsobject
  Show child attributesHide child attributes
  docsarray of objects
  Show child attributesHide child attributes
  idstring
  businessIdsarray of strings
  valueInCentsinteger
  subjectstring
  hashstring
  originTypestring
  Possible values:paymentdepositwithdraw-requesttransfer-requestwithdraw-feeanticipation-taxrefund-taxrefund-shortfallexternal-liquidationpromissoryother
  ocurredAtstring
  groupIdstring
  referenceIdstring
  descriptionstring
  currentPageinteger
  hasNextboolean
  limitinteger
  nextPageintegernullable
  totalDocsinteger
  totalPagesinteger
- countinteger
- totalValueinteger

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid field

Example:Unauthorized
errorstring
Unauthorized

Example:Unauthorized
statusCodeinteger
401

Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Forbidden resource

Example:Forbidden resource
errorstring
Forbidden

Example:Forbidden
statusCodeinteger
403

Example:403

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error