Listar faturas
Lista faturas e, opcionalmente, notas de crédito e de débito.
GET/v1/workspaces/{regionId}/invoices
Parâmetros
fromstringData/timestamp ISO 8601 - só são retornados os itens criados nessa data ou depois dela.
tostringData/timestamp ISO 8601 - só são retornados os itens criados nessa data ou antes dela.
documentTypestringPor padrão, o que é pago: faturas e as notas de débito que as alteram. invoice (só faturas), debit_note, credit_note (os mesmos itens de ListCreditNotes) ou all (todos os tipos, do mais recente para o mais antigo). Todo item traz documentType. Qualquer outro valor é 400 DOCUMENT_TYPE_INVALID.
Retorna
200 OK com o objeto mostrado na resposta.
Mais detalhes
Lista faturas, sem ordem definida - ou, com documentType, notas de crédito ou ambas: faturas e notas de crédito são um único recurso de documentos, e cada item diz qual é em documentType. Quem chama como Comprador recebe as faturas que o seu espaço de trabalho recebeu; quem chama como Fornecedor recebe as faturas que emitiu para compradores conectados, seja qual for o espaço de trabalho de comprador em que cada uma está. Opcionalmente restrito a um intervalo de createdAt via from/to - passe os limites de um mês do calendário para ter uma visão por mês. Quem chama como Fornecedor recebe uma visão reduzida de cada fatura (veja GetInvoice) - os detalhes internos de conciliação do comprador e o fluxo de aprovação completo ficam ocultos.
Erros
- 401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
- 403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/invoices" \
-H "X-Api-Key: $PLEAXY_API_KEY"[
{
"documentType": "invoice" | "debit_note",
"amendsInvoiceId": "string",
"amendsExternalInvoiceNumber": "string",
"debitNoteIds": [ "string" ],
"replacesInvoiceIds": [ "string" ],
"replacedByInvoiceIds": [ "string" ],
"replacement": { "creditedInFull": boolean, "uncredited": number },
"uncreditedOriginals": [ { "invoiceId": "string", "externalInvoiceNumber": "string", "uncredited": number, "currency": "string" } ],
"id": "string",
"po": "string",
"poLineNo": number,
"billsNoPoLine": true,
"buyerOrgId": "string",
"supplierOrgId": "string",
"supplier": "string",
"amount": number,
"currency": "string",
"usageAmount": number,
"usageCurrency": "string",
"tolerancePct": number,
"matchStatus": "pending" | "matched" | "discrepancy" | "unverified",
"unverifiedReason": "no_purchase_order" | "no_billing_connection" | "debit_note",
"discrepancyReason": "amount" | "currency",
"paid": boolean,
"dueInDays": number,
"approval": {
"requester": "string",
"requesterEmployeeKey": "string",
"groups": [
{
"id": "string",
"mode": "sequential" | "parallel",
"label": "string",
"status": "pending" | "approved" | "rejected",
"stages": [
{ "id": "string", "label": "string", "approverEmployeeKey": "string", "approverName": "string", "status": "pending" | "approved" | "rejected" }
]
}
],
"groupIndex": number,
"status": "pending" | "approved" | "rejected",
"history": [
{ "stage": "string", "by": "string", "at": "string", "action": "approved" | "rejected" | "limit_exceeded" | "reassigned" | "skipped" }
],
"autonomy": boolean,
"selfApproved": boolean
},
"createdAt": "string",
"lastRemindedAt": "string",
"rejection": { "reasonCode": "amount_incorrect" | "not_ordered_or_not_received" | "duplicate" | "missing_or_wrong_po" | "wrong_billing_entity" | "other", "reason": "string", "at": "string" },
"replacesInvoiceId": "string",
"source": "po-flip" | "direct" | "manual" | "feed",
"submittedFormat": "json" | "cxml" | "ubl",
"submittedBy": "string",
"externalInvoiceNumber": "string",
"lineItems": [
{ "description": "string", "qty": number, "unitPrice": number, "discount": number, "charge": number, "amount": number }
],
"adjustments": [
{ "type": "discount" | "charge", "description": "string", "amount": number }
],
"taxAmount": number,
"taxBreakdown": [ { "description": "string", "rate": number, "amount": number } ],
"paymentCurrencyAmount": { "currencyCode": "string", "totalAmount": number, "currencyExchangeDetails": { "rate": number, "rateDate": "string", "rateSource": "string" } },
"taxCurrencyAmount": { "currencyCode": "string", "amountBreakdown": { "taxes": { "totalAmount": number } }, "currencyExchangeDetails": { "rate": number, "rateDate": "string", "rateSource": "string" } },
"baseCurrencyAmount": { "currencyCode": "string", "totalAmount": number },
"rateWarnings": [
{ "object": "payment" | "tax", "currency": "string", "statedRate": number, "referenceRate": number, "source": "provider" | "override", "asOf": "string", "deviationPct": number }
],
"withholdings": [ { "description": "string", "rate": number, "amount": number } ],
"deductions": [ { "kind": "prepayment" | "credit", "description": "string", "amount": number, "reference": "string", "paidOn": "string", "sourceInvoiceId": "string", "stated": true } ],
"invoiceKind": "prepayment",
"creditNoteIds": [ "string" ],
"creditApplications": [ { "id": "string", "creditNoteId": "string", "externalCreditNoteNumber": "string", "amount": number, "appliedAt": "string", "appliedByName": "string", "auto": true } ],
"payment": { "status": "recorded", "method": "ach" | "wire" | "check" | "card" | "other" | "credit", "paymentDate": "string", "reference": "string", "paidAmount": { "amount": number, "currency": "string", "rate": number, "rateDate": "string" } },
"remittances": [ { "id": "string", "sentAt": "string", "sentByName": "string", "note": "string", "file": { "fileName": "string", "contentType": "application/pdf" | "image/png" | "image/jpeg", "sizeBytes": number } } ]
}
]