Rechnungen auflisten
Listet Rechnungen und optional Gutschriften und Belastungsanzeigen auf.
GET/v1/workspaces/{regionId}/invoices
Parameter
fromstringISO-8601-Datum/Zeitstempel - nur Einträge, die zu oder nach diesem Zeitpunkt angelegt wurden, werden zurückgegeben.
tostringISO-8601-Datum/Zeitstempel - nur Einträge, die zu oder vor diesem Zeitpunkt angelegt wurden, werden zurückgegeben.
documentTypestringStandardmäßig das, was bezahlt wird: Rechnungen und die Belastungsanzeigen, die sie ändern. invoice (nur Rechnungen), debit_note, credit_note (dieselben Einträge wie bei ListCreditNotes) oder all (alle Arten, neueste zuerst). Jeder Eintrag enthält documentType. Alles andere ergibt 400 DOCUMENT_TYPE_INVALID.
Rückgabe
200 OK mit dem in der Antwort gezeigten Objekt.
Weitere Details
Listet Rechnungen in keiner bestimmten Reihenfolge auf - oder, mit documentType, Gutschriften oder beides: Rechnungen und Gutschriften sind eine gemeinsame Ressource von Abrechnungsbelegen, und jeder Eintrag gibt in documentType an, was er ist. Ein Aufrufer mit Käuferrolle erhält die Rechnungen, die sein Workspace empfangen hat; ein Aufrufer mit Lieferantenrolle erhält die Rechnungen, die er an verbundene Käufer ausgestellt hat, in welchem Käufer-Workspace sie auch liegen. Optional per from/to auf einen createdAt-Bereich eingeschränkt - übergeben Sie die Grenzen eines Kalendermonats, um eine Monatsansicht zu erhalten. Ein Aufrufer mit Lieferantenrolle erhält von jeder Rechnung eine reduzierte Ansicht (siehe GetInvoice) - die internen Abgleichdaten des Käufers und der vollständige Freigabeablauf werden nicht ausgegeben.
Fehler
- 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
- 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
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 } } ]
}
]