Finance Payout Specification Example

Detta exempel visar hur man hämtar Finance Payout Specifications med specifika query-parametrar för paginering och dataprojektion.

Finance Payout Specifications ger detaljerad finansiell transaktionsdata inklusive kapitalbelopp, räntekostnader, borgenärskommissioner och momsberäkningar. Varje specifikation representerar en finansiell post som bidrar till den övergripande utbetalningsberäkningen för Creditors, visar uppdelningen av insamlade medel per kategori (kapital, ränta, påminnelseavgifter) och deras nuvarande bearbetningstillstånd.

Alla API-requests kräver en giltig autentiseringstoken i X-API-Key header. För detaljer om autentiseringsprocessen och tokenhantering, se Authentication documentation.

I denna guide kommer vi att använda AuthTokenProvider-klassen (dokumenterad i autentiseringsguiden) för att hantera tokenhantering.

Hämta Finance Payout Specifications

Hämta Finance Payout Specifications med Finance Payout Specification endpoint med Pagination and Queries:

TypeScriptPython

typescript

const token = await auth.getValidToken()

const query = encodeURIComponent(JSON.stringify({}))
const projection = encodeURIComponent(
  JSON.stringify({
    booking_date: 1,
    article: 1,
    state: 1,
    total_amount: 1,
    amount: 1,
    vat_amount: 1,
    finance_category: 1,
    payout_reference: 1,
    reference_number: 1,
    invoice_number: 1,
  })
)

const response = await axios.get(
  `https://api-sandbox.amili.se/finance--payout-specifications?page=1&max_results=20&sort=-_created&projection=${projection}&where=${query}`,
  {
    headers: {
      'X-API-Key': token,
    },
  }
)

python

import json

token = auth.get_valid_token()

query = json.dumps({})
projection = json.dumps({
  "booking_date": 1,
  "article": 1,
  "state": 1,
  "total_amount": 1,
  "amount": 1,
  "vat_amount": 1,
  "finance_category": 1,
  "payout_reference": 1,
  "reference_number": 1,
  "invoice_number": 1
})

response = requests.get(
  'https://api-sandbox.amili.se/finance--payout-specifications',
  params={
    'page': 1,
    'max_results': 20,
    'sort': '-_created',
    'projection': projection,
    'where': query
  },
  headers={'X-API-Key': token}
)
response.raise_for_status()
result = response.json()

Svaret kommer att vara:

json

{
  "_items": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "amount": 60.0,
      "vat_amount": 15.0,
      "total_amount": 75.0,
      "article": "reminder",
      "state": "reminder",
      "booking_date": "Wed, 11 Jun 2025 00:00:00 GMT",
      "finance_category": "creditor_commission",
      "_updated": "Wed, 11 Jun 2025 14:00:18 GMT",
      "_created": "Wed, 11 Jun 2025 14:00:18 GMT",
      "_etag": "a1b2c3d4e5f678901234567890123456",
      "invoice_number": "INV-2025-020",
      "reference_number": "25020"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "amount": 1064,
      "vat_amount": 0.0,
      "total_amount": 1064.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Wed, 11 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Wed, 11 Jun 2025 14:00:18 GMT",
      "_created": "Wed, 11 Jun 2025 14:00:17 GMT",
      "_etag": "b2c3d4e5f67890123456789012345678",
      "invoice_number": "INV-2025-020",
      "reference_number": "25020"
    },
    {
      "_id": "507f1f77bcf86cd799439013",
      "amount": 10000,
      "vat_amount": 0.0,
      "total_amount": 10000.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Thu, 05 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_created": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_etag": "c3d4e5f6789012345678901234567890",
      "invoice_number": "INV-2025-019",
      "reference_number": "25019"
    },
    {
      "_id": "507f1f77bcf86cd799439014",
      "amount": 3209,
      "vat_amount": 0.0,
      "total_amount": 3209.0,
      "article": "interest",
      "state": "reminder",
      "booking_date": "Thu, 05 Jun 2025 00:00:00 GMT",
      "finance_category": "interest",
      "_updated": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_created": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_etag": "d4e5f6789012345678901234567890ab",
      "invoice_number": "INV-2025-018",
      "reference_number": "25018"
    },
    {
      "_id": "507f1f77bcf86cd799439015",
      "amount": 12000,
      "vat_amount": 0.0,
      "total_amount": 12000.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Thu, 05 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_created": "Thu, 05 Jun 2025 11:30:14 GMT",
      "_etag": "e5f6789012345678901234567890abcd",
      "invoice_number": "INV-2025-018",
      "reference_number": "25018"
    },
    {
      "_id": "507f1f77bcf86cd799439016",
      "amount": 3014,
      "vat_amount": 0.0,
      "total_amount": 3014.0,
      "article": "interest",
      "state": "reminder",
      "booking_date": "Tue, 03 Jun 2025 00:00:00 GMT",
      "finance_category": "interest",
      "_updated": "Tue, 03 Jun 2025 11:13:15 GMT",
      "_created": "Tue, 03 Jun 2025 11:13:15 GMT",
      "_etag": "f6789012345678901234567890abcdef",
      "invoice_number": "INV-2025-017",
      "reference_number": "25017"
    },
    {
      "_id": "507f1f77bcf86cd799439017",
      "amount": 3700,
      "vat_amount": 0.0,
      "total_amount": 3700.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Tue, 03 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Tue, 03 Jun 2025 11:13:15 GMT",
      "_created": "Tue, 03 Jun 2025 11:13:15 GMT",
      "_etag": "789012345678901234567890abcdef12",
      "invoice_number": "INV-2025-017",
      "reference_number": "25017"
    },
    {
      "_id": "507f1f77bcf86cd799439018",
      "amount": 1000,
      "vat_amount": 0.0,
      "total_amount": 1000.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Tue, 03 Jun 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Tue, 03 Jun 2025 06:17:12 GMT",
      "_created": "Tue, 03 Jun 2025 06:17:12 GMT",
      "_etag": "89012345678901234567890abcdef1234",
      "invoice_number": "INV-2025-016",
      "reference_number": "25016"
    },
    {
      "_id": "507f1f77bcf86cd799439019",
      "amount": 20,
      "vat_amount": 0.0,
      "total_amount": 20.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Fri, 09 May 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Fri, 09 May 2025 13:03:19 GMT",
      "_created": "Fri, 09 May 2025 13:03:19 GMT",
      "_etag": "9012345678901234567890abcdef1234",
      "invoice_number": "INV-2025-015",
      "reference_number": "25015"
    },
    {
      "_id": "507f1f77bcf86cd799439020",
      "amount": 70,
      "vat_amount": 0.0,
      "total_amount": 70.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Fri, 09 May 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Fri, 09 May 2025 13:03:18 GMT",
      "_created": "Fri, 09 May 2025 13:03:18 GMT",
      "_etag": "012345678901234567890abcdef1234",
      "invoice_number": "INV-2025-014",
      "reference_number": "25014"
    },
    {
      "_id": "507f1f77bcf86cd799439021",
      "amount": 25,
      "vat_amount": 0.0,
      "total_amount": 25.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Fri, 09 May 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Fri, 09 May 2025 13:03:18 GMT",
      "_created": "Fri, 09 May 2025 13:03:18 GMT",
      "_etag": "123456789012345678901234567890ab",
      "invoice_number": "INV-2025-013",
      "reference_number": "25013"
    },
    {
      "_id": "507f1f77bcf86cd799439022",
      "amount": 50,
      "vat_amount": 0.0,
      "total_amount": 50.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Fri, 09 May 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Fri, 09 May 2025 13:03:18 GMT",
      "_created": "Fri, 09 May 2025 13:03:18 GMT",
      "_etag": "23456789012345678901234567890abc",
      "invoice_number": "INV-2025-012",
      "reference_number": "25012"
    },
    {
      "_id": "507f1f77bcf86cd799439023",
      "amount": 12500,
      "vat_amount": 0.0,
      "total_amount": 12500.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Tue, 29 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Tue, 29 Apr 2025 06:40:15 GMT",
      "_created": "Tue, 29 Apr 2025 06:40:15 GMT",
      "_etag": "3456789012345678901234567890abcd",
      "invoice_number": "INV-2025-011",
      "reference_number": "25011"
    },
    {
      "_id": "507f1f77bcf86cd799439024",
      "amount": 6250,
      "vat_amount": 0.0,
      "total_amount": 6250.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Mon, 28 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Mon, 28 Apr 2025 19:00:16 GMT",
      "_created": "Mon, 28 Apr 2025 19:00:16 GMT",
      "_etag": "456789012345678901234567890abcdef",
      "invoice_number": "INV-2025-010",
      "reference_number": "25010"
    },
    {
      "_id": "507f1f77bcf86cd799439025",
      "amount": 112.0,
      "vat_amount": 0.0,
      "total_amount": 112.0,
      "article": "interest",
      "state": "reminder",
      "booking_date": "Mon, 28 Apr 2025 00:00:00 GMT",
      "finance_category": "interest",
      "_updated": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_created": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_etag": "56789012345678901234567890abcdef",
      "invoice_number": "INV-2025-009",
      "reference_number": "25009"
    },
    {
      "_id": "507f1f77bcf86cd799439026",
      "amount": 60.0,
      "vat_amount": 15.0,
      "total_amount": 75.0,
      "article": "reminder",
      "state": "reminder",
      "booking_date": "Mon, 28 Apr 2025 00:00:00 GMT",
      "finance_category": "creditor_commission",
      "_updated": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_created": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_etag": "6789012345678901234567890abcdef1",
      "invoice_number": "INV-2025-009",
      "reference_number": "25009"
    },
    {
      "_id": "507f1f77bcf86cd799439027",
      "amount": 1875.0,
      "vat_amount": 0.0,
      "total_amount": 1875.0,
      "article": "capital",
      "state": "reminder",
      "booking_date": "Mon, 28 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_created": "Mon, 28 Apr 2025 15:40:17 GMT",
      "_etag": "789012345678901234567890abcdef12",
      "invoice_number": "INV-2025-009",
      "reference_number": "25009"
    },
    {
      "_id": "507f1f77bcf86cd799439028",
      "amount": 500,
      "vat_amount": 0.0,
      "total_amount": 500.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Thu, 24 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Thu, 24 Apr 2025 08:40:18 GMT",
      "_created": "Thu, 24 Apr 2025 08:40:18 GMT",
      "_etag": "89012345678901234567890abcdef12",
      "invoice_number": "INV-2025-008",
      "reference_number": "25008"
    },
    {
      "_id": "507f1f77bcf86cd799439029",
      "amount": 5000,
      "vat_amount": 0.0,
      "total_amount": 5000.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Thu, 24 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Thu, 24 Apr 2025 08:00:19 GMT",
      "_created": "Thu, 24 Apr 2025 08:00:19 GMT",
      "_etag": "9012345678901234567890abcdef12",
      "invoice_number": "INV-2025-008",
      "reference_number": "25008"
    },
    {
      "_id": "507f1f77bcf86cd799439030",
      "amount": 1064,
      "vat_amount": 0.0,
      "total_amount": 1064.0,
      "article": "capital",
      "state": "initializing",
      "booking_date": "Thu, 24 Apr 2025 00:00:00 GMT",
      "finance_category": "capital",
      "_updated": "Thu, 24 Apr 2025 07:50:16 GMT",
      "_created": "Thu, 24 Apr 2025 07:50:16 GMT",
      "_etag": "012345678901234567890abcdef1234",
      "invoice_number": "INV-2025-008",
      "reference_number": "25008"
    }
  ],
  "_meta": {
    "page": 1,
    "max_results": 20,
    "total": 162
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309

Finance Payout Specification Example ​

Hämta Finance Payout Specifications ​

Finance Payout Specification Example

Hämta Finance Payout Specifications