OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| description | string | Não | Filtra pela descrição da conta. |
| dateInputStart | date-time | Não | Filtra contas com data de lançamento a partir de uma data (YYYY-MM-DD). |
| dateInputEnd | date-time | Não | Filtra contas com data de lançamento até uma data (YYYY-MM-DD). |
| dueDateStart | date-time | Não | Filtra contas com data de vencimento a partir de uma data (YYYY-MM-DD). |
| dueDateEnd | date-time | Não | Filtra contas com data de vencimento até uma data (YYYY-MM-DD). |
| datePaymentStart | date-time | Não | Filtra contas com data de pagamento a partir de uma data (YYYY-MM-DD). |
| datePaymentEnd | date-time | Não | Filtra contas com data de pagamento até uma data (YYYY-MM-DD). |
| compentenceStart | date-time | Não | Filtra contas com data de competência a partir de uma data (YYYY-MM-DD). |
| competenceEnd | date-time | Não | Filtra contas com data de competência até uma data (YYYY-MM-DD). |
| bankAccount | string | Não | Filtra pelas contas bancárias associadas. Pode usar múltiplos IDs separados por vírgula, ex: 2,215. |
| ammountStart | number | Não | Filtra contas com valor mínimo a pagar. |
| ammountEnd | number | Não | Filtra contas com valor máximo a pagar. |
| accountStatus | string | Não | Filtra pelo status da conta. Utilize IDs separados por vírgula: 1 - Aberta, 2 - Paga, 3 - Cancelada. |
| take | int32 | Não | Número total de registros a serem retornados. Valor padrão: 50. Máximo permitido: 50. |
| skip | int32 | Não | Número total de registros a serem ignorados (para paginação). Valor padrão: 0. |
| Campo | Tipo | Descrição |
|---|---|---|
idPayable | int32 | Identificador único da conta a pagar. |
description | string | Descrição da conta a pagar. |
recipient | string | Destinatário do pagamento. |
costCenter | object | Centro de custo associado à conta a pagar. Veja mais abaixo. |
inputDate | date-time | Data de lançamento da conta a pagar. |
dueDate | date-time | Data de vencimento da conta a pagar. |
paymentDate | date-time | Data em que o pagamento foi realizado. |
competenceDate | date-time | Data de competência contábil da conta. |
cancellationDate | date-time | Data de cancelamento da conta a pagar, se aplicável. |
ammount | number | Valor total da conta a pagar. |
ammountPaid | number | Valor efetivamente pago. |
status | object | Status atual da conta a pagar. Veja mais abaixo. |
destination | object | Destino financeiro do pagamento. Veja mais abaixo. |
bankAccount | object | Conta bancária utilizada para o pagamento. Veja mais abaixo. |
beneficiary | string | Beneficiário do pagamento. |
categories | string | Categoria(s) associada(s) à conta a pagar. |
observation | string | Observações adicionais sobre a conta a pagar. |
costCenter| Campo | Tipo | Descrição |
|---|---|---|
id | int32 | Identificador do centro de custo. |
name | string | Nome do centro de custo. |
status| Campo | Tipo | Descrição |
|---|---|---|
id | int32 | Identificador do status da conta a pagar. |
name | string | Nome ou descrição do status. |
destination| Campo | Tipo | Descrição |
|---|---|---|
id | int32 | Identificador do destino financeiro. |
name | string | Nome do destino financeiro. |
bankAccount| Campo | Tipo | Descrição |
|---|---|---|
id | int32 | Identificador da conta bancária. |
name | string | Nome ou descrição da conta bancária. |
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/payables?description=undefined&dateInputStart=undefined&dateInputEnd=undefined&dueDateStart=undefined&dueDateEnd=undefined&datePaymentStart=undefined&datePaymentEnd=undefined&compentenceStart=undefined&competenceEnd=undefined&bankAccount=undefined&ammountStart=undefined&ammountEnd=undefined&accountStatus=undefined&idBranch=undefined&take=undefined&skip=undefined' \
--header 'Authorization: Basic <encoded-value>'{
"idPayable": 0,
"description": "string",
"recipient": "string",
"costCenter": {
"id": 0,
"name": "string"
},
"inputDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"paymentDate": "2019-08-24T14:15:22.123Z",
"competenceDate": "2019-08-24T14:15:22.123Z",
"cancellationDate": "2019-08-24T14:15:22.123Z",
"ammount": 0,
"ammountPaid": 0,
"status": {
"id": 0,
"name": "string"
},
"destination": {
"id": 0,
"name": "string"
},
"bankAccount": {
"id": 0,
"name": "string"
},
"beneficiary": "string",
"categories": "string",
"observation": "string"
}