Elencare le fatture
Elenca le fatture e, facoltativamente, le note di credito e di debito.
GET/v1/workspaces/{regionId}/invoices
Parametri
fromstringData/timestamp ISO 8601: vengono restituiti solo gli elementi creati in questo momento o dopo.
tostringData/timestamp ISO 8601: vengono restituiti solo gli elementi creati in questo momento o prima.
documentTypestringPer impostazione predefinita, ciò che si paga: le fatture e le note di debito che le rettificano. invoice (solo fatture), debit_note, credit_note (gli stessi elementi di ListCreditNotes), oppure all (tutti i tipi, dal più recente). Ogni elemento riporta documentType. Qualsiasi altro valore restituisce 400 DOCUMENT_TYPE_INVALID.
Restituisce
200 OK con l’oggetto mostrato nella risposta.
Più dettagli
Elenca le fatture, senza un ordine particolare, oppure, con documentType, le note di credito o entrambe: fatture e note di credito sono un’unica risorsa di documenti, e ogni elemento indica in documentType di quale si tratta. Un chiamante Acquirente riceve le fatture ricevute dal suo workspace; un chiamante Fornitore riceve le fatture che ha emesso verso gli acquirenti collegati, in qualunque workspace acquirente si trovino. Con from/to puoi limitarle a un intervallo di createdAt: passa i limiti di un mese di calendario per avere una vista mensile. Un chiamante Fornitore riceve una vista ridotta di ogni fattura (vedi GetInvoice): i dettagli interni di riconciliazione dell’acquirente e il flusso di approvazione completo non vengono restituiti.
Errori
- 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
- 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
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 } } ]
}
]