Centrum pomocyIntegracje

Dla: Administratorzy

Odczyt faktur za pomocą klucza zarządzającego

Sporządź listę faktur opublikowanych przez Twoją firmę i przeczytaj jedną z nich, wraz z kwotami, płatnościami i zwrotami, na potrzeby własnej księgowości lub raportu.

W tym artykule4 sekcji

Zanim zaczniesz

Ta strona obejmuje informacje dotyczące czytania faktur. Klawisz „https://prd-api-manage.caseactive.com/v1/<hub id>” służy do przeglądania wszystkich publikowanych faktur, w tym także tych zamkniętych spraw. Klawisz ten nie pozwala na tworzenie, zmiany, zwrot lub płacenie faktur.

Połączenia

DzwonićCo to robi
GET /invoicesLista publikowanych faktur, najnowsze na początku.
GET /invoices/<case_id>/<invoice_id>Czytanie jednego faktury
ParametrCo to robiWymaganyDomyślny
statusTylko faktury o tym statusie: open, paid, void, uncollectible lub processingNieWszystko
case_idTylko faktury z jednego przypadkuNieKażdy przypadek
limitIle faktur może znajdować się na jednej stronie – maksymalnie 1000.Nie20
start_keystartKey z poprzedniej stronyNieStrona pierwsza

Jeśli pozostają jeszcze faktury, zadzwoń do nextLink lub wyślij startKey jako start_key. Ten list nie ma żadnych filtrów dotyczących daty ani ostatniego zmiany faktur. Aby dowiedzieć się, co się zmieniło od twojej ostatniej synchronizacji, włączając w to płatności i zwrot pieniędzy, przeszukaj tabelę case_invoices za pomocą filter_by=updated_on:>, po którym następuje czas twojej ostatniej synchronizacji w sekundach według standardów Unixa. Zmiany zostają uwzględnione w wyniku przeszukiwania kilka sekund po ich zapisaniu. Dlatego należy rozpocząć każdą sesję przeszukiwania nieco przed zakończeniem poprzedniej. Dodaj filter_by=refund_status:=succeeded, aby znaleźć informacje o zwrocach pieniędzy. Zobacz Przeszukiwanie przypadków i użytkowników za pomocą narzędzia do zarządzania.

Faktura

Każda kwota jest liczbą całkowitą w centach, w dolarach amerykańskich: 96300 wynosi 963,00 dolarów.

{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "invoice_id": "invoice::20260915143000_ab12cd34ef5678",
    "host_id": "ca-7e6d5c4b3a2f10",
    "name": "September legal services",
    "description": "Consultation and filing for Jane Sample's claim",
    "invoice_number": "INV-1042",
    "po_number": "PO-778",
    "terms": "Net 15",
    "host_ref_id": "acct-1042",
    "notes": "Thank you for your business.",
    "participants_ids": ["cu-4f1c2a9e8b7d60"],
    "user_id": "cu-9d8c7b6a5f4e30",
    "status": "paid",
    "due_date": "2026-09-30T17:00:00+00:00",
    "transactions": {
      "transactions": [
        {"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
        {"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
      ],
      "discount": 0.1,
      "tax": 0.07
    },
    "subtotal": 100000,
    "discount": 0.1,
    "discount_amount": 10000,
    "discounted_amount": 90000,
    "tax": 0.07,
    "tax_amount": 6300,
    "total": 96300,
    "payment_gateway": "stripe",
    "stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
    "payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
    "completed_on": "2026-09-20T14:05:20+00:00",
    "published": 1,
    "created_on": "2026-09-15T14:30:00+00:00",
    "updated_on": "2026-09-20T14:05:20+00:00"
  }
}
PoleCo zawiera
invoice_id, case_idFaktura, a także to, na którym znajduje się. Proszę przeczytać jedną fakturę, ale zarówno tę, która jest na tym towarze.
name, descriptionTytuł i opis
invoice_number, po_number, terms, notes, host_ref_idZapisane na fakturze. host_ref_id to jej identyfikator.
participants_idsLudzie, którym to służą.
user_idKto je stworzył?
statusopen: czeka na wypłatę. paid: wypłacone online lub oznaczone jako wypłacone. void: anulowane. uncollectible i processing: ustalone przez twoich pracowników. paid i void są ostateczne.
due_dateKiedy nadszedł czas
transactionsJego linie to: każda z nich to charge lub credit, a także description, value w centach oraz quantity. Ponadto występują stawki, które są stosowane w tym przypadku.
subtotalZaliczki pomijając kredyty, nigdy nie mogą być niższe niż 0.
discount, discount_amount, discounted_amountStawka dyskontowa w formie ułamka0.1 To jest 10%, rabat w centach, a potem suma całkowita.
tax, tax_amountStawkę podatku w postaci ułamka0.07 To jest 7%. Podatek w centach, wynikający z kwoty po odliczeniu należności.
totalIle należy zapłacić, w centach
payment_gatewaystripe gdy płatność nastąpi online, manual gdy jej zidentyfikuje wasz personel.
stripe_paymentW przypadku płatności online: kto zapłacił, jakie są koszty oraz kwota w centach.
payment_attemptsKażdy próbuje płacić online: kiedy to się udało, i dlaczego nie udało się.
refundedA także zwrot pieniędzy, jeśli takowy istnieje: w formie status (pending, succeeded, failed lub canceled), amount w centach oraz reason. Stan samych faktur pozostaje paid.
completed_onGdy płatność została dokonana lub pieniądze zostały anulowane.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
404InvoiceDoesNotExistExceptionNa tym pakiecie nie ma żadnej faktury z takim identyfikatorem, w twoim hubie.
400InvoiceNotPublishedExceptionFaktura jest w formie weksla.
400SchemaFieldsExceptionstatus nie należy do tych pięciu.
400InvalidStartKeyExceptionstart_key nie należy do tej listy.

Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.

Powiązane artykuły

Obsługa błędów API i kodów statusuPrzeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.Integracje