Search all invoices

Returns all invoices according to the informed query params in the request.

Paging params


  • By page numbers:?from={int}&to={int}

Date params


You can refine the API response using the two date params that will always be used in ISO8601 format.

  • By creation date: ?createdDateFrom={dateISO8601}&createDateTo={dateISO8601}
  • By due date: ?dueDateFrom={dateISO8601}&dueDateTo={dateISO8601}

Other filters


For proper responses, you can use the filters below:

  • By value: ?value={decimal}
  • By status: ?status={string}
  • By Id: ?Id={string}
  • By observation: ?observation={string}
  • By creditAccountId: ?creditAccountId={creditAcountId}

Combine filters


You can use the query parameter op to specify if filters will be evaluated as AND or OR for the query. In this case, the default is AND.

Let's see how it works?

For example, if we take the query string ?value=100&status=Paid, the criteria will build value=100 AND status=Paid.

Now, if we take the same query string and add the op parameter, the result will be ?value=100&status=Paid&op=or and the criteria will build value=100 OR status=Paid


Response body has the following properties:

Name Type Mandatory Description
id string Yes
friendlyId string
status string Yes
value decimal Yes
accountId string Yes
creditValue decimal Yes
createdAt string Yes
resolvedAt string
updatedAt string Yes
paymentLink string
originalDueDate string Yes
dueDate string Yes
installment number
orderId string
observation string
transactionId string Yes
numberOfInstallments number Yes
creditAccountId string Yes

Response body example:

{
            "id": "",
            "friendlyId": "",
            "status": "Paid",
            "value": 101.22,
            "accountId": "",
            "creditValue": 0.0,
            "createdAt": "2019-12-08T16:13:36.0469451Z",
            "resolvedAt": "2019-12-17T15:28:25.1776415Z",
            "updatedAt": "2019-12-17T15:28:25.240167Z",
            "paymentLink": "",  
            "originalDueDate": "2020-01-07T16:13:36.0469451Z",
            "dueDate": "2020-01-07T16:13:36.0469451Z",
            "installment": 1,
            "orderId": "",
            "transactionId": "",
            "numberOfInstallments": 1,
            "creditAccountId": ""
        },
Language
Authentication
URL
Click Try It! to start a request and see the response here!