Wgraj pliki kosztów

Zakres: api:costs:write. Wgrywa pliki jako skany dokumentów do przetworzenia na koszty. Przyjmuje pliki PDF, JPG i PNG do 15 MB każdy; zawartość pliku musi odpowiadać rozszerzeniu. Zwraca 422, gdy którykolwiek plik zostanie odrzucony; poprawne pliki z tego samego żądania i tak są zapisywane i wymienione z success: true.

POST

https://api.sandbox-infakt.pl/v3/documents/costs/upload.json

Autoryzacja

ApiKey
opcjonalne
API key in header

Token
opcjonalne
API key in header

Treść żądania FORM-DATA required

uploads[]
array of
string
wymagane
PDF, JPG lub PNG, do 15 MB każdy. Powtórz część dla każdego pliku.

format: binary

Odpowiedzi

201

Utworzono

JSON

entities
array of
object
wymagane
- success
  boolean
  wymagane
- name
  string
  wymagane
- document_scan_uuid
  opcjonalne
  string
  Tylko dla udanych wgrań.
  
  format: uuid
- download_url
  opcjonalne
  string
  Tylko dla udanych wgrań. Ścieżka pliku w aplikacji inFakt, /app/uploads/{upload_uuid}; otwiera się w sesji przeglądarki, nie z kluczem API.
- errors
  opcjonalne
  array of
  string
  Tylko dla nieudanych wgrań.
}

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

406

Ścieżka nie kończy się na .json.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

422

Co najmniej jeden plik został odrzucony. Pozostałe pliki z żądania i tak są zapisywane.

JSON

success
false
wymagane
entities
array of
object
wymagane
- success
  boolean
  wymagane
- name
  string
  wymagane
- document_scan_uuid
  opcjonalne
  string
  Tylko dla udanych wgrań.
  
  format: uuid
- download_url
  opcjonalne
  string
  Tylko dla udanych wgrań. Ścieżka pliku w aplikacji inFakt, /app/uploads/{upload_uuid}; otwiera się w sesji przeglądarki, nie z kluczem API.
- errors
  opcjonalne
  array of
  string
  Tylko dla nieudanych wgrań.
}

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

curl --request POST \ --url https://api.sandbox-infakt.pl/v3/documents/costs/upload.json \ --header 'X-inFakt-ApiKey: <X-inFakt-ApiKey>' \ --form 'uploads[]=@<uploads[]>;type=application/pdf' \ --form 'uploads[]=@<uploads[]>;type=application/pdf'

{ "entities": [ { "success": true, "name": "faktura.pdf", "document_scan_uuid": "8b9c0d1e-2f3a-4b5c-8d6e-7f8a9b0c1d2e", "download_url": "/app/uploads/c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f" } ] }

{ "success": false, "entities": [ { "success": true, "name": "faktura.pdf", "document_scan_uuid": "8b9c0d1e-2f3a-4b5c-8d6e-7f8a9b0c1d2e", "download_url": "/app/uploads/c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f" }, { "success": false, "name": "zestawienie.csv", "errors": [ "Załączony format pliku jest nieobsługiwany. Załącz plik w formacie: jpg, png lub pdf." ] } ] }