API ReferenceInvoice
Retrieves the collection of Invoice resources.
Retrieves the collection of Invoice resources.
Authorization
apiKey Authorization<token>
Value for the Authorization header parameter.
In: header
Query Parameters
page?integer
The collection page number
Default
1itemsPerPage?integer
The number of items per page
Range
0 <= value <= 100Default
30search?string
isNotPaid?boolean
sent_to_ksef?boolean
ksef_sent?boolean
financeProject?string
financeProject[]?array<string>
financeStage?string
financeStage[]?array<string>
financeBoard?string
financeBoard[]?array<string>
financeTask?string
financeTask[]?array<string>
sellerId?string
sellerId[]?array<string>
buyerId?string
buyerId[]?array<string>
createdBy?string
createdBy[]?array<string>
direction?string
direction[]?array<string>
invoiceNumber?string
invoiceType?string
invoiceType[]?array<string>
posted?boolean
isDraft?boolean
isExternal?boolean
exists[corrects]?boolean
netAmount[between]?string
netAmount[gt]?string
netAmount[gte]?string
netAmount[lt]?string
netAmount[lte]?string
createdAt[before]?string
createdAt[strictly_before]?string
createdAt[after]?string
createdAt[strictly_after]?string
updatedAt[before]?string
updatedAt[strictly_before]?string
updatedAt[after]?string
updatedAt[strictly_after]?string
issueDate[before]?string
issueDate[strictly_before]?string
issueDate[after]?string
issueDate[strictly_after]?string
deadlineDate[before]?string
deadlineDate[strictly_before]?string
deadlineDate[after]?string
deadlineDate[strictly_after]?string
order[invoiceNumber]?string
Default
"asc"Value in
- "asc"
- "desc"
order[isDraft]?string
Default
"asc"Value in
- "asc"
- "desc"
order[posted]?string
Default
"asc"Value in
- "asc"
- "desc"
order[invoiceType]?string
Default
"asc"Value in
- "asc"
- "desc"
order[financeProject.name]?string
Default
"asc"Value in
- "asc"
- "desc"
order[buyerIdentifier]?string
Default
"asc"Value in
- "asc"
- "desc"
order[createdAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[issueDate]?string
Default
"asc"Value in
- "asc"
- "desc"
order[netAmount]?string
Default
"asc"Value in
- "asc"
- "desc"
order[deadlineDate]?string
Default
"asc"Value in
- "asc"
- "desc"
Response Body
curl -X GET "https://example.com/finance/invoices"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ksefStatus": 0, "ksefStatusDescription": "string", "ksefMarker": "NrKSeF", "no": "string", "ksefNumber": "string", "docTitle": "string", "saleDate": "2019-08-24T14:15:22Z", "issueDate": "2019-08-24T14:15:22Z", "invoicingDate": "2019-08-24T14:15:22Z", "acquisitionDate": "2019-08-24T14:15:22Z", "permanentStorageDate": "2019-08-24T14:15:22Z", "deadlineDate": "2019-08-24T14:15:22Z", "invoiceType": "fv", "direction": "income", "sellerName": "string", "sellerIdentifier": "string", "sellerStreet": "string", "sellerZipCode": "string", "sellerCity": "string", "sellerCreatorName": "string", "sellerId": "2b5cb5ab-0f11-4d75-8f0a-a6d87a9d534e", "buyerId": "7925fb6c-1391-458a-9144-275078d9f24b", "buyerContractorName": "string", "buyerName": "string", "buyerIdentifier": "string", "buyerStreet": "string", "buyerZipCode": "string", "buyerCity": "string", "currencyCode": "str", "paymentMethod": "cash", "alreadyPaid": 0, "toPay": 0, "netAmount": 0.1, "vatAmount": 0.1, "grossAmount": 0.1, "hasIncome": false, "hasCost": false, "posted": false, "external": true, "numbering": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "fv", "pattern": "string", "resetInterval": "P1M", "leadingZero": 0, "isDefault": true, "docTitle": "string", "closestCounter": null }, "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true }, "financeStage": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true } }, "financeBoard": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true }, "financeStage": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true } } }, "financeTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "number": 0, "shortCode": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true }, "financeStage": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true } }, "financeBoard": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true }, "financeStage": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "financeProject": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "shortCode": "string", "no": "string", "isSimple": true } } } }, "isDraft": true, "isSplitPayment": true, "isReverseCharge": true, "isCashAccounting": true, "createdBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "shortCode": "string", "firstName": "string", "lastName": "string", "email": "string", "phoneNumber": "string", "pictureSm": "string", "pictureLg": "string", "canLogIn": false, "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7", "contractorName": "string", "jobPositionName": "string" }, "createdAt": "2019-08-24T14:15:22Z", "isUpdated": false, "updatedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "shortCode": "string", "firstName": "string", "lastName": "string", "email": "string", "phoneNumber": "string", "pictureSm": "string", "pictureLg": "string", "canLogIn": false, "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7", "contractorName": "string", "jobPositionName": "string" }, "updatedAt": "2019-08-24T14:15:22Z", "fileGenerated": false, "duplicateFileGenerated": false, "costs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "priceNet": 0.1, "priceGross": 0.1, "costType": "manually", "date": "2019-08-24T14:15:22Z" } ], "incomes": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "priceNet": 0.1, "priceGross": 0.1, "incomeType": "manually", "date": "2019-08-24T14:15:22Z" } ] }]