-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaccounting.yaml
11843 lines (11572 loc) · 559 KB
/
accounting.yaml
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
servers:
- description: Production
url: 'https://api.codat.io'
info:
title: Accounting API
version: 3.0.0
contact:
email: [email protected]
name: Codat
description: |-
> ### New to Codat?
>
> Our Accounting API reference is relevant only to our existing clients.
> Please reach out to your Codat contact so that we can find the right product for you.
A flexible API for pulling accounting data, normalized and aggregated from 20 accounting integrations.
Standardize how you connect to your customers’ accounting software. View, create, update, and delete data in the same way for all the leading accounting platforms.
<!-- Start Codat Tags Table -->
## Endpoints
| Endpoints | Description |
| :- |:- |
| Accounts | Access standardized Accounts from linked accounting platforms. |
| Account transactions | Access standardized Account transactions from linked accounting platforms. |
| Bank accounts | Access standardized Bank accounts from linked accounting platforms. |
| Bank account transactions | Access standardized Bank transactions for bank accounts from linked accounting platforms. |
| Bills | Access standardized Bills from linked accounting platforms. |
| Bill credit notes | Access standardized Bill credit notes from linked accounting platforms. |
| Bill payments | Access standardized Bill payments from linked accounting platforms. |
| Credit notes | Access standardized Credit notes from linked accounting platforms. |
| Customers | Access standardized Customers from linked accounting platforms. |
| Direct costs | Access standardized Direct costs from linked accounting platforms. |
| Direct incomes | Access standardized Direct incomes from linked accounting platforms. |
| Company info | Access standardized Company info from linked accounting platforms. |
| Invoices | Access standardized Invoices from linked accounting platforms. |
| Item receipts | Access standardized Item receipts from linked accounting platforms. |
| Items | Access standardized Items from linked accounting platforms. |
| Journals | Access standardized Journals from linked accounting platforms. |
| Journal entries | Access standardized Journal entries from linked accounting platforms. |
| Payments | Access standardized Payments from linked accounting platforms. |
| Payment methods | Access standardized Payment methods from linked accounting platforms. |
| Purchase orders | Access standardized Purchase orders from linked accounting platforms. |
| Sales orders | Access standardized Sales orders from linked accounting platforms. |
| Suppliers | Access standardized Suppliers from linked accounting platforms. |
| Tax rates | Access standardized Tax rates from linked accounting platforms. |
| Tracking categories | Access standardized Tracking categories from linked accounting platforms. |
| Transfers | Access standardized Transfers from linked accounting platforms. |
| Reports | Access standardized Reports from linked accounting platforms. |
<!-- End Codat Tags Table -->
[Read more...](https://docs.codat.io/accounting-api/overview)
[See our OpenAPI spec](https://github.com/codatio/oas)
termsOfService: 'https://www.codat.io/legals/'
security:
- auth_header: []
x-speakeasy-retries:
strategy: backoff
backoff:
initialInterval: 500
maxInterval: 60000
maxElapsedTime: 3600000
exponent: 1.5
statusCodes:
- 408
- 429
- 5XX
retryConnectionErrors: true
x-speakeasy-name-override:
- operationId: ^list-.*?
methodNameOverride: list
- operationId: ^list-.*?-attachments
methodNameOverride: list-attachments
- operationId: ^get-.*?
methodNameOverride: get
- operationId: ^get-create-.*?-model
methodNameOverride: get-create-model
- operationId: ^get-create-update.*?-model
methodNameOverride: get-create-update-model
- operationId: ^get-.*?-attachment
methodNameOverride: get-attachment
- operationId: ^update-.*?
methodNameOverride: update
- operationId: ^create-.*?
methodNameOverride: create
- operationId: ^delete-.*?
methodNameOverride: delete
- operationId: ^delete-.*?-attachment
methodNameOverride: delete-attachment
- operationId: ^download-.*?-attachment
methodNameOverride: download-attachment
- operationId: ^upload-.*?-attachment
methodNameOverride: upload-attachment
x-codat-docs-path: codat-api
x-codat-speakeasy-pagination:
type: offsetLimit
inputs:
- name: page
in: parameters
type: page
outputs:
results: $.results
tags:
- name: Accounts
description: Access standardized Accounts from linked accounting platforms.
- name: Account transactions
description: Access standardized Account transactions from linked accounting platforms.
- name: Bank accounts
description: Access standardized Bank accounts from linked accounting platforms.
- name: Bank account transactions
description: Access standardized Bank transactions for bank accounts from linked accounting platforms.
- name: Bills
description: Access standardized Bills from linked accounting platforms.
- name: Bill credit notes
description: Access standardized Bill credit notes from linked accounting platforms.
- name: Bill payments
description: Access standardized Bill payments from linked accounting platforms.
- name: Credit notes
description: Access standardized Credit notes from linked accounting platforms.
- name: Customers
description: Access standardized Customers from linked accounting platforms.
- name: Direct costs
description: Access standardized Direct costs from linked accounting platforms.
- name: Direct incomes
description: Access standardized Direct incomes from linked accounting platforms.
- name: Company info
description: Access standardized Company info from linked accounting platforms.
- name: Invoices
description: Access standardized Invoices from linked accounting platforms.
- name: Item receipts
description: Access standardized Item receipts from linked accounting platforms.
- name: Items
description: Access standardized Items from linked accounting platforms.
- name: Journals
description: Access standardized Journals from linked accounting platforms.
- name: Journal entries
description: Access standardized Journal entries from linked accounting platforms.
- name: Payments
description: Access standardized Payments from linked accounting platforms.
- name: Payment methods
description: Access standardized Payment methods from linked accounting platforms.
- name: Purchase orders
description: Access standardized Purchase orders from linked accounting platforms.
- name: Sales orders
description: Access standardized Sales orders from linked accounting platforms.
- name: Suppliers
description: Access standardized Suppliers from linked accounting platforms.
- name: Tax rates
description: Access standardized Tax rates from linked accounting platforms.
- name: Tracking categories
description: Access standardized Tracking categories from linked accounting platforms.
- name: Transfers
description: Access standardized Transfers from linked accounting platforms.
- name: Reports
description: Access standardized Reports from linked accounting platforms.
paths:
'/companies/{companyId}/connections/{connectionId}/data/accountTransactions':
get:
summary: List account transactions
description: |-
The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection.
[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
operationId: list-account-transactions
tags:
- Account transactions
parameters:
- $ref: '#/components/parameters/companyId'
- $ref: '#/components/parameters/connectionId'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/orderBy'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AccountTransactions'
examples:
Clear Books:
value:
results:
- id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285
transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1
note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197
bankAccountRef:
id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
name: Undeposited Funds
date: '2022-04-19T00:00:00'
status: Unreconciled
currency: GBP
currencyRate: 1
lines:
- description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197
recordRef:
id: 38e8c917-0afc-4583-8ffe-1b53ad601197
dataType: directIncomes
amount: 188.33
totalAmount: 188.33
modifiedDate: '2023-04-26T12:38:18'
sourceModifiedDate: '2022-05-13T01:06:00'
metadata:
isDeleted: false
- id: f2656119-9521-4d51-a24d-003b44c1410b
transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946
note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8
bankAccountRef:
id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
name: Undeposited Funds
date: '2022-04-19T00:00:00'
status: Void
currency: GBP
currencyRate: 1
lines:
- description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8
recordRef:
id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8
dataType: directIncomes
amount: 32095.91
totalAmount: 32095.91
modifiedDate: '2023-04-26T12:38:18'
sourceModifiedDate: '2023-02-13T00:34:00'
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 1745
_links:
current:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2
self:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions
next:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2
QuickBooks Desktop:
value:
results:
- id: D7B-933784104
transactionId: D7B-933784104
bankAccountRef:
id: 20000-933270541
name: Checking
date: '2022-12-01T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: D7B-933784104
dataType: directCosts
amount: -1200
totalAmount: -1200
modifiedDate: '2023-04-26T09:13:23'
sourceModifiedDate: '2023-12-16T05:04:10'
metadata:
isDeleted: false
- id: DFA-933785132
transactionId: DFA-933785132
bankAccountRef:
id: 20000-933270541
name: Checking
date: '2022-12-05T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: DFA-933785132
dataType: directCosts
amount: -35
totalAmount: -35
modifiedDate: '2023-04-26T09:13:23'
sourceModifiedDate: '2023-12-16T05:04:11'
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 652
_links:
current:
href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2
self:
href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions
next:
href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2
QuickBooks Online Sandbox:
value:
results:
- id: '85'
transactionId: '85'
note: Opening Balance from Bank
bankAccountRef:
id: '57'
name: Visa Credit Card
date: '2015-08-12T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- description: Opening Balance from Bank
recordRef:
id: PUR-85
dataType: directCosts
amount: -3831.8
totalAmount: -3831.8
modifiedDate: '2023-04-26T09:37:16'
sourceModifiedDate: '2016-09-12T18:13:07Z'
metadata:
isDeleted: false
- id: '5'
transactionId: '5'
bankAccountRef:
id: '81'
name: Current
date: '2015-11-24T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- description: contribution to start business
recordRef:
id: 5-1
dataType: directIncomes
amount: 10000
- description: funds borrowed to start business
recordRef:
id: 5-2
dataType: directIncomes
amount: 25000
totalAmount: 35000
modifiedDate: '2023-04-26T09:37:17'
sourceModifiedDate: '2016-09-12T15:26:26Z'
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 9141
_links:
current:
href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2
self:
href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions
next:
href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2
QuickBooks Online:
value:
results:
- id: '1'
transactionId: '1'
note: Opening Balance from Bank
bankAccountRef:
id: '61'
name: Dave PP Current
date: '2018-09-21T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: '1'
dataType: directIncomes
amount: 170.23
totalAmount: 170.23
modifiedDate: '2023-01-18T11:03:12'
sourceModifiedDate: '2018-12-17T14:56:20Z'
- id: '15'
transactionId: '15'
note: Payment to Google
bankAccountRef:
id: '61'
name: Dave PP Current
date: '2018-09-21T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- description: Payment to Google
recordRef:
id: PUR-15
dataType: directCosts
amount: -1.59
totalAmount: -1.59
modifiedDate: '2023-01-18T11:03:11'
sourceModifiedDate: '2018-12-17T14:56:44Z'
pageNumber: 1
pageSize: 2
totalResults: 5984
_links:
current:
href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2
self:
href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions
next:
href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2
Xero:
value:
results:
- id: 74004690-82a1-4810-aaca-6ce575af94b4
transactionId: 74004690-82a1-4810-aaca-6ce575af94b4
bankAccountRef:
id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4
name: Business Bank Account
date: '2021-12-20T00:00:00'
status: Reconciled
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: 74004690-82a1-4810-aaca-6ce575af94b4
dataType: billPayments
amount: -7267.2
totalAmount: -7267.2
modifiedDate: '2023-03-15T20:37:10'
sourceModifiedDate: '2021-01-02T22:51:40'
metadata:
isDeleted: false
- id: 65b746c8-9a5d-4a95-8096-d2316fcff592
transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592
bankAccountRef:
id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4
name: Business Bank Account
date: '2022-02-17T00:00:00'
status: Reconciled
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: 65b746c8-9a5d-4a95-8096-d2316fcff592
dataType: payments
amount: 4200
totalAmount: 4200
modifiedDate: '2023-03-15T20:37:10'
sourceModifiedDate: '2021-01-02T22:50:58'
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 70
_links:
current:
href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2
self:
href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions
next:
href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2
'400':
$ref: '#/components/responses/Malformed-Query'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/Payment-Required'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/Not-Found'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/Too-Many-Requests'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'503':
$ref: '#/components/responses/Service-Unavailable'
'/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}':
get:
tags:
- Account transactions
summary: Get account transaction
operationId: get-account-transaction
description: |
The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction.
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
parameters:
- $ref: '#/components/parameters/companyId'
- $ref: '#/components/parameters/connectionId'
- name: accountTransactionId
in: path
required: true
schema:
type: string
description: Unique identifier for an account transaction.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AccountTransaction'
examples:
Clear Books:
value:
id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285
transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1
note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197
bankAccountRef:
id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3
name: Undeposited Funds
date: '2022-04-19T00:00:00'
status: Unreconciled
currency: GBP
currencyRate: 1
lines:
- description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197
recordRef:
id: 38e8c917-0afc-4583-8ffe-1b53ad601197
dataType: directIncomes
amount: 188.33
totalAmount: 188.33
modifiedDate: '2023-04-26T12:38:18'
sourceModifiedDate: '2022-05-13T01:06:00'
metadata:
isDeleted: false
QuickBooks Desktop:
value:
id: D7B-933784104
transactionId: D7B-933784104
bankAccountRef:
id: 20000-933270541
name: Checking
date: '2022-12-01T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: D7B-933784104
dataType: directCosts
amount: -1200
totalAmount: -1200
modifiedDate: '2023-04-26T09:13:23'
sourceModifiedDate: '2023-12-16T05:04:10'
metadata:
isDeleted: false
QuickBooks Online Sandbox:
value:
id: '85'
transactionId: '85'
note: Opening Balance from Bank
bankAccountRef:
id: '57'
name: Visa Credit Card
date: '2015-08-12T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- description: Opening Balance from Bank
recordRef:
id: PUR-85
dataType: directCosts
amount: -3831.8
totalAmount: -3831.8
modifiedDate: '2023-04-26T09:37:16'
sourceModifiedDate: '2016-09-12T18:13:07Z'
metadata:
isDeleted: false
QuickBooks Online:
value:
id: '1'
transactionId: '1'
note: Opening Balance from Bank
bankAccountRef:
id: '61'
name: Dave PP Current
date: '2018-09-21T00:00:00'
status: Unknown
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: '1'
dataType: directIncomes
amount: 170.23
totalAmount: 170.23
modifiedDate: '2023-01-18T11:03:12'
sourceModifiedDate: '2018-12-17T14:56:20Z'
Xero:
value:
id: 74004690-82a1-4810-aaca-6ce575af94b4
transactionId: 74004690-82a1-4810-aaca-6ce575af94b4
bankAccountRef:
id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4
name: Business Bank Account
date: '2021-12-20T00:00:00'
status: Reconciled
currency: GBP
currencyRate: 1
lines:
- recordRef:
id: 74004690-82a1-4810-aaca-6ce575af94b4
dataType: billPayments
amount: -7267.2
totalAmount: -7267.2
modifiedDate: '2023-03-15T20:37:10'
sourceModifiedDate: '2021-01-02T22:51:40'
metadata:
isDeleted: false
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/Payment-Required'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/Not-Found'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/Too-Many-Requests'
'500':
$ref: '#/components/responses/Internal-Server-Error'
'503':
$ref: '#/components/responses/Service-Unavailable'
'/companies/{companyId}/data/accounts':
get:
tags:
- Accounts
summary: List accounts
description: "\uFEFFThe *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data)."
operationId: list-accounts
parameters:
- $ref: '#/components/parameters/companyId'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/orderBy'
responses:
'200':
description: Success
content:
application/json:
x-speakeasy-usage-example: true
schema:
$ref: '#/components/schemas/Accounts'
examples:
Clear Books:
value:
results:
- id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e
nominalCode: '610'
name: Accounts Receivable
description: Invoices the business has issued but has not yet collected payment on.
fullyQualifiedCategory: Asset.Current
fullyQualifiedName: Asset.Current.Accounts Receivable
currency: GBP
currentBalance: 0
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-04-26T12:38:15Z'
sourceModifiedDate: '2022-12-10T16:39:00'
validDatatypeLinks: []
metadata:
isDeleted: false
- id: 76d5f23b-9623-4e3b-89cd-da57228764d3
nominalCode: '611'
name: Accounts Receivable
description: A provision anticipating that a portion of accounts receivable will never be collected.
fullyQualifiedCategory: Asset.Current
fullyQualifiedName: Asset.Current.Accounts Receivable
currency: GBP
currentBalance: 0
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-04-26T12:38:15Z'
sourceModifiedDate: '2022-10-19T05:49:00'
validDatatypeLinks: []
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 98
_links:
current:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2
self:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts
next:
href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2
Dynamics 365 Business Central:
value:
results:
- id: 8eaed16d-c69f-ec11-80f1-0022481b4546
nominalCode: 45422026-68CA-4EF2-9
name: ''
fullyQualifiedCategory: ' .'
fullyQualifiedName: ..
currency: GBP
currentBalance: 0
type: Unknown
status: Active
isBankAccount: false
modifiedDate: '2023-03-27T14:21:18Z'
sourceModifiedDate: '2022-03-09T16:31:54Z'
validDatatypeLinks:
- property: Id
links:
- DirectCost.LineItems.AccountRef.Id
metadata:
isDeleted: false
- id: c0861a65-c69f-ec11-80f1-0022481b4546
nominalCode: '10'
name: Account no cat Balance Sheet
fullyQualifiedCategory: ' .'
fullyQualifiedName: ..Account no cat Balance Sheet
currency: GBP
currentBalance: 27.34
type: Unknown
status: Active
isBankAccount: false
modifiedDate: '2023-03-27T14:21:18Z'
sourceModifiedDate: '2022-09-13T14:45:01Z'
validDatatypeLinks:
- property: Id
links:
- DirectCost.LineItems.AccountRef.Id
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 122
_links:
current:
href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2
self:
href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts
next:
href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2
Exact (Netherlands):
value:
results:
- id: ef2fde36-4416-4bc5-b239-315b2929348c
nominalCode: '1300'
name: Debiteuren
description: Debiteuren
fullyQualifiedCategory: Asset.Assets.AccountsReceivable
fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled
currency: EUR
currentBalance: 864435.44
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2022-10-26T13:36:17Z'
sourceModifiedDate: '2020-01-08T09:42:54Z'
validDatatypeLinks:
- property: Id
links:
- Transfer.To.AccountRef.Id
- Transfer.From.AccountRef.Id
- Payment.AccountRef.Id
- BillPayment.AccountRef.Id
- id: 2052b65b-20e9-4da1-85d8-fd5ca0ea3d38
nominalCode: '888777888'
name: One more AR account
description: One more AR account
fullyQualifiedCategory: Asset.Assets.AccountsReceivable
fullyQualifiedName: Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled
currency: EUR
currentBalance: 2174.82
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2022-10-26T13:36:17Z'
sourceModifiedDate: '2021-06-10T11:00:20Z'
validDatatypeLinks:
- property: Id
links:
- Transfer.To.AccountRef.Id
- Transfer.From.AccountRef.Id
- Payment.AccountRef.Id
- BillPayment.AccountRef.Id
pageNumber: 1
pageSize: 2
totalResults: 230
_links:
current:
href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2
self:
href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts
next:
href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2
Exact (UK):
value:
results:
- id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40
nominalCode: THING
name: Some thing account
description: Some thing account
fullyQualifiedCategory: Asset.Assets.AccountsReceivable
fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled
currency: GBP
currentBalance: 0
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2022-10-26T13:35:15Z'
sourceModifiedDate: '2017-08-01T17:31:12Z'
validDatatypeLinks:
- property: Id
links:
- Transfer.To.AccountRef.Id
- Transfer.From.AccountRef.Id
- Payment.AccountRef.Id
- BillPayment.AccountRef.Id
- id: cf9572e7-8afa-4339-9113-af32a66d9df9
nominalCode: '15400'
name: Trade Debtors
description: Trade Debtors
fullyQualifiedCategory: Asset.Assets.AccountsReceivable
fullyQualifiedName: Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled
currency: GBP
currentBalance: 4484655.39
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2022-10-26T13:35:15Z'
sourceModifiedDate: '2020-01-08T13:48:38Z'
validDatatypeLinks:
- property: Id
links:
- Transfer.To.AccountRef.Id
- Transfer.From.AccountRef.Id
- Payment.AccountRef.Id
- BillPayment.AccountRef.Id
pageNumber: 1
pageSize: 2
totalResults: 121
_links:
current:
href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2
self:
href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts
next:
href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2
FreeAgent:
value:
results:
- id: '601'
nominalCode: '601'
name: Capital Asset Brought Forward
fullyQualifiedCategory: Asset.Capital
fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward
currency: GBP
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-04-25T14:19:12Z'
validDatatypeLinks: []
metadata:
isDeleted: false
- id: '605'
nominalCode: '605'
name: Capital Asset Depreciation Brought Forward
fullyQualifiedCategory: Asset.Capital
fullyQualifiedName: Asset.Capital.Capital Asset Depreciation Brought Forward
currency: GBP
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-04-25T14:19:12Z'
validDatatypeLinks: []
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 292
_links:
current:
href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2
self:
href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts
next:
href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2
FreshBooks:
value:
results:
- id: '67357'
nominalCode: '1200'
name: Accounts Receivable
fullyQualifiedCategory: Asset
fullyQualifiedName: Asset.Accounts Receivable
currency: GBP
currentBalance: 51445.53
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-03-24T16:07:24Z'
validDatatypeLinks: []
metadata:
isDeleted: false
- id: '128611'
nominalCode: 1200-1
name: Accounts Receivable
fullyQualifiedCategory: Asset.Accounts Receivable
fullyQualifiedName: Asset.Accounts Receivable.Accounts Receivable
currency: GBP
currentBalance: 51445.53
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-03-24T16:07:24Z'
validDatatypeLinks: []
metadata:
isDeleted: false
pageNumber: 1
pageSize: 2
totalResults: 96
_links:
current:
href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2
self:
href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts
next:
href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2
KashFlow:
value:
results:
- id: '27840056'
nominalCode: '70700'
name: 16th Account
fullyQualifiedCategory: Asset.BankAccount
fullyQualifiedName: Asset.BankAccount.16th Account
currency: GBP
currentBalance: 0
type: Asset
status: Active
isBankAccount: true
modifiedDate: '2022-09-30T10:29:16Z'
validDatatypeLinks: []
- id: '27840049'
nominalCode: '70600'
name: 1a1a
fullyQualifiedCategory: Asset.BankAccount
fullyQualifiedName: Asset.BankAccount.1a1a
currency: GBP
currentBalance: 0
type: Asset
status: Active
isBankAccount: true
modifiedDate: '2022-09-30T10:29:16Z'
validDatatypeLinks: []
pageNumber: 1
pageSize: 2
totalResults: 157
_links:
current:
href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2
self:
href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts
next:
href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2
Oracle NetSuite:
value:
results:
- id: '111'
name: Accounts Payable
fullyQualifiedCategory: AcctPay.AcctPay
fullyQualifiedName: AcctPay.AcctPay.Accounts Payable
currentBalance: -635.55
type: Liability
status: Active
isBankAccount: false
modifiedDate: '2023-01-30T14:48:33Z'
sourceModifiedDate: '2021-08-11T12:51:21'
validDatatypeLinks: []
- id: '119'
name: Accounts Receivable
fullyQualifiedCategory: AcctRec.AcctRec
fullyQualifiedName: AcctRec.AcctRec.Accounts Receivable
currentBalance: -565
type: Asset
status: Active
isBankAccount: false
modifiedDate: '2023-01-30T14:48:33Z'
sourceModifiedDate: '2021-09-08T15:23:31'
validDatatypeLinks: []
pageNumber: 1
pageSize: 2
totalResults: 44
_links:
current:
href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2
self:
href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts
next:
href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2