get
https://api.operand.app/beta/financial/bills
Query stringssss
| Finalidade | |
|---|---|
| offset | deslocamento, salta a quantidade de registros informada |
| limit | quantidade de registros retornados |
| order | ordenação ascendente ou descendente |
| Field | Type | Field Name corresponding | Description | Return Type |
|---|---|---|---|---|
| attachments | Array of Object | Anexos | Retorna um array com um ou mais objetos contendo dados dos anexos | null ou array de objeto(s) |
| accrualDate | Datetime | Competência | Retorna a data e hora de competencia da fatura. Formatos: YYYY-MM-DD HH:MM:SS. | string em branco ou Data e hora |
| billNumber | Integer | Parcela | Retorna o número correspondente da parcela. | string em branco ou inteiro |
| billQuantity | Integer | Parcela | Retorna o número total de parcelas. | string em branco ou inteiro |
| billTitle | String | Título | Retorna o título do documento. | string (campo obrigatório) |
| billType | Enum | Tipo de cliente | Informa o tipo de cliente. | Obrigatório - 'balance', 'transfer', 'client', 'supplier', 'provider', 'vehicle', 'employee' |
| companyId | Integer | ID da Empresa | Retorna o ID de cadastro da empresa. | |
| createdDate | Datetime | Data e hora de criação | Retorna data e hora da criação do documento. Formatos: YYYY-MM-DD HH:MM:SS. | |
| discountValue | Decimal | Desconto | Retorna o valor de desconto da fatura. | |
| documentNumber | String | N° Documento ou NF | Retorna o número do documento ou da Nota Fiscal. | |
| dueDate | Datetime | Vencimento | Retorna a data e hora de vencimento da fatura. Formatos: YYYY-MM-DD HH:MM:SS. | |
| entPersonId | Bigint | ID cadastro | Retorna o ID de cadastro. | |
| finAccountId | Integer | ID da conta | Retorna o ID da conta bancária do documento. | |
| finBillId | Integer | Número do documento | Retorna o número do documento. | |
| finCategoryId | Integer | ID da categoria | Retorna o ID da categoria. | |
| finCostCenterId | Integer | ID do Centro de Custo | Retorna o ID do Centro de Custo. | |
| finPaymentMethodId | Integer | ID do Método de Pagamento | Retorna o ID do Método de Pagamento. | |
| groupedIntoId | Integer | ?? | ||
| hasBilling | Tinyint | Verifica se há faturamento | Retorna código indicando se há faturamento. | |
| increaseValue | Decimal | Acréscimo | Retorna o valor de acréscimo no valor da fatura. | |
| orderNumber | String | Número da ordem | Retorna o número da ordem | |
| paymentCondition | Enum | Condição de Pagamento | Retorna a condição de pagamento. | |
| paymentDate | Datetime | Data de Pagamento | Retorna data e hora do pagamento. Formatos: YYYY-MM-DD HH:MM:SS. | |
| referrerClientId | Bigint | ID do cliente de referência | Retorna o ID do cliente de referência. | |
| relatedDoc | String | Tipo de relacionamento | Retorna o tipo de relacionamento. | |
| relatedDocuments | String | Tipo e ID do relacionamento | Retorna o tipo e o ID do relacionamento. | |
| situation | Enum | Status/Situação | Retorna a situação/status do documento. | |
| statusId | Integer | ID Status/Situação | Retorna o ID do situação/status do documento. | |
| totalValue | Decimal | Valor Total | Retorna o valor total do documento. | |
| updatedDate | Datetime | Data e hora de atualização | Retorna a data e horário da última alteração. Formatos: YYYY-MM-DD HH:MM:SS. | |
| userId | Integer | ID do usuário | Retorna o ID do usuário que criou o documento. | |
| value | Decimal | Valor sem acréscimo ou desconto | Retorna o valor do documento sem acréscimo ou desconto. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…