Follow the question structure recommended by Dev Bot before submitting your integration questions.
NOTE. Available for use with branch access key and also with General ADM access key.
| Parameter | Type | Required | Description |
|---|---|---|---|
| dtStart | string(date-time) | Yes | Start date of the period to be queried. |
| dtEnd | string(date-time) | Yes | End date of the period to be queried. |
π§ The return of this endpoint is in XML. That is, you will not receive a commonjson.
| Field | Type | Description |
|---|---|---|
| idFilial | int32 | Identifier of the branch. |
| nomeFilial | string | Name of the branch. |
| idCliente | int32 | Identifier of the client. |
| status | string | Status of the contract or client. |
| contratoAtivo | string | Indicates if the contract was active before termination. |
| nome | string | Name of the client. |
| sobrenome | string | Surname of the client. |
| contratoVencido | string | Indicates if the contract expired in the specified period. |
| dataInicio | string(date-time) | Start date of the contract. |
| dataFim | string(date-time) | End date of the contract. |
| mesesPermanencia | int32 | Number of months of contract permanence. |
| valor | decimal | Value of the contract. |
| flCancelado | boolean | Indicates if the contract was canceled. |
| dtCancelamento | string(date-time) | Cancellation date of the contract (if applicable). |
| contratoCancelado | string | Description of the canceled contract. |
| motivoCancelamento | string | Reason for the cancellation provided. |
| nomeConsultor | string | Name of the consultant responsible for the client. |
| celular | string | Phone number of the client. |
| string | Email of the client. |