{"openapi":"3.0.3","info":{"title":"ERPspan API","version":"1.0.0","description":"Read + write REST API over Microsoft Dynamics GP. All `/v1/{object}` routes require a bearer API key and an `X-Connection-Id` header. Money values are decimal strings."},"servers":[{"url":"/","description":"This server"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"companies"},{"name":"customers"},{"name":"customer-addresses"},{"name":"vendors"},{"name":"vendor-addresses"},{"name":"items"},{"name":"item-quantities"},{"name":"accounts"},{"name":"gl-entries"},{"name":"ar-invoices"},{"name":"ar-payments"},{"name":"ap-invoices"},{"name":"ap-payments"},{"name":"sales-orders"},{"name":"purchase-orders"},{"name":"sites"},{"name":"checkbooks"},{"name":"payment-terms"},{"name":"salespeople"},{"name":"fiscal-periods"},{"name":"batches"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key: `Authorization: Bearer lb_…`"}},"schemas":{"Error":{"type":"object","description":"The 03 §B error envelope.","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string"},"details":{"type":"object","additionalProperties":true,"nullable":true}},"required":["code","message"]}},"required":["error"]},"Company":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"number":{"type":"number","nullable":true}},"required":["id","name","number"],"additionalProperties":false},"Customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"statementName":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"classId":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"primaryAddressCode":{"type":"string","nullable":true},"paymentTermsId":{"type":"string","nullable":true},"salespersonId":{"type":"string","nullable":true},"salesTerritoryId":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true},"creditLimit":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"taxScheduleId":{"type":"string","nullable":true},"inactive":{"type":"boolean"},"hold":{"type":"boolean"},"createdAt":{"type":"string","nullable":true},"modifiedAt":{"type":"string","nullable":true}},"required":["id","name","statementName","shortName","classId","contactPerson","primaryAddressCode","paymentTermsId","salespersonId","salesTerritoryId","currencyId","creditLimit","phone","taxScheduleId","inactive","hold","createdAt","modifiedAt"],"additionalProperties":false},"CustomerAddress":{"type":"object","properties":{"customerId":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"shippingMethodId":{"type":"string","nullable":true},"taxScheduleId":{"type":"string","nullable":true}},"required":["customerId","code","contactPerson","line1","line2","line3","city","state","postalCode","country","phone","shippingMethodId","taxScheduleId"],"additionalProperties":false},"Vendor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"checkName":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"classId":{"type":"string","nullable":true},"primaryAddressCode":{"type":"string","nullable":true},"paymentTermsId":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"ten99Type":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"hold":{"type":"boolean"},"createdAt":{"type":"string","nullable":true},"modifiedAt":{"type":"string","nullable":true}},"required":["id","name","checkName","shortName","classId","primaryAddressCode","paymentTermsId","currencyId","taxId","ten99Type","phone","status","hold","createdAt","modifiedAt"],"additionalProperties":false},"VendorAddress":{"type":"object","properties":{"vendorId":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true}},"required":["vendorId","code","contactPerson","line1","line2","line3","city","state","postalCode","country","phone"],"additionalProperties":false},"Item":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"classId":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"tracking":{"type":"string","nullable":true},"uomScheduleId":{"type":"string","nullable":true},"standardCost":{"type":"string","nullable":true},"currentCost":{"type":"string","nullable":true},"genericDescription":{"type":"string","nullable":true},"inactive":{"type":"boolean"},"modifiedAt":{"type":"string","nullable":true}},"required":["id","description","shortName","classId","type","tracking","uomScheduleId","standardCost","currentCost","genericDescription","inactive","modifiedAt"],"additionalProperties":false},"ItemQuantity":{"type":"object","properties":{"itemId":{"type":"string","nullable":true},"siteId":{"type":"string","nullable":true},"qtyOnHand":{"type":"string","nullable":true},"qtyAllocated":{"type":"string","nullable":true},"qtyOnOrder":{"type":"string","nullable":true},"qtyBackordered":{"type":"string","nullable":true},"qtyAvailable":{"type":"string","nullable":true}},"required":["itemId","siteId","qtyOnHand","qtyAllocated","qtyOnOrder","qtyBackordered","qtyAvailable"],"additionalProperties":false},"Account":{"type":"object","properties":{"id":{"type":"string"},"index":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"postingType":{"type":"string","nullable":true},"active":{"type":"boolean"},"categoryId":{"type":"number","nullable":true},"createdAt":{"type":"string","nullable":true},"modifiedAt":{"type":"string","nullable":true}},"required":["id","index","description","type","postingType","active","categoryId","createdAt","modifiedAt"],"additionalProperties":false},"GlEntry":{"type":"object","properties":{"journalEntryNumber":{"type":"number","nullable":true},"series":{"type":"number","nullable":true},"sourceDocument":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"lineDescription":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"debit":{"type":"string","nullable":true},"credit":{"type":"string","nullable":true},"originatingSource":{"type":"string","nullable":true},"originatingMasterId":{"type":"string","nullable":true},"originatingDocument":{"type":"string","nullable":true}},"required":["journalEntryNumber","series","sourceDocument","reference","lineDescription","date","accountNumber","debit","credit","originatingSource","originatingMasterId","originatingDocument"],"additionalProperties":false},"ArDocument":{"type":"object","properties":{"type":{"type":"string","nullable":true},"documentNumber":{"type":"string","nullable":true},"customerId":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"originalAmount":{"type":"string","nullable":true},"remainingAmount":{"type":"string","nullable":true},"salesAmount":{"type":"string","nullable":true},"taxAmount":{"type":"string","nullable":true},"freightAmount":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"batchId":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true},"voided":{"type":"boolean"},"checkNumber":{"type":"string","nullable":true}},"required":["type","documentNumber","customerId","date","dueDate","originalAmount","remainingAmount","salesAmount","taxAmount","freightAmount","description","batchId","currencyId","voided","checkNumber"],"additionalProperties":false},"ApDocument":{"type":"object","properties":{"type":{"type":"string","nullable":true},"voucherNumber":{"type":"string","nullable":true},"vendorDocumentNumber":{"type":"string","nullable":true},"vendorId":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"originalAmount":{"type":"string","nullable":true},"remainingAmount":{"type":"string","nullable":true},"purchasesAmount":{"type":"string","nullable":true},"taxAmount":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"batchId":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true},"voided":{"type":"boolean"}},"required":["type","voucherNumber","vendorDocumentNumber","vendorId","date","dueDate","originalAmount","remainingAmount","purchasesAmount","taxAmount","description","batchId","currencyId","voided"],"additionalProperties":false},"SalesOrder":{"type":"object","properties":{"type":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"docTypeId":{"type":"string","nullable":true},"customerId":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"subtotal":{"type":"string","nullable":true},"taxAmount":{"type":"string","nullable":true},"freightAmount":{"type":"string","nullable":true},"total":{"type":"string","nullable":true},"batchId":{"type":"string","nullable":true},"siteId":{"type":"string","nullable":true},"customerPONumber":{"type":"string","nullable":true},"voided":{"type":"boolean"}},"required":["type","number","docTypeId","customerId","customerName","date","subtotal","taxAmount","freightAmount","total","batchId","siteId","customerPONumber","voided"],"additionalProperties":false},"SalesOrderLine":{"type":"object","properties":{"itemId":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"string","nullable":true},"unitPrice":{"type":"string","nullable":true},"extendedPrice":{"type":"string","nullable":true},"siteId":{"type":"string","nullable":true},"qtyFulfilled":{"type":"string","nullable":true}},"required":["itemId","description","quantity","unitPrice","extendedPrice","siteId","qtyFulfilled"],"additionalProperties":false},"PurchaseOrder":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"vendorId":{"type":"string","nullable":true},"vendorName":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"promisedDate":{"type":"string","nullable":true},"subtotal":{"type":"string","nullable":true},"taxAmount":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true}},"required":["id","status","type","vendorId","vendorName","date","promisedDate","subtotal","taxAmount","currencyId"],"additionalProperties":false},"PurchaseOrderLine":{"type":"object","properties":{"lineNumber":{"type":"number","nullable":true},"itemId":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"qtyOrdered":{"type":"string","nullable":true},"qtyCanceled":{"type":"string","nullable":true},"unitCost":{"type":"string","nullable":true},"extendedCost":{"type":"string","nullable":true},"siteId":{"type":"string","nullable":true}},"required":["lineNumber","itemId","description","qtyOrdered","qtyCanceled","unitCost","extendedCost","siteId"],"additionalProperties":false},"Site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"required":["id","name","line1","line2","city","state","postalCode","country"],"additionalProperties":false},"Checkbook":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"cashAccountNumber":{"type":"string","nullable":true},"currencyId":{"type":"string","nullable":true},"currentBalance":{"type":"string","nullable":true},"inactive":{"type":"boolean"}},"required":["id","name","cashAccountNumber","currencyId","currentBalance","inactive"],"additionalProperties":false},"PaymentTerm":{"type":"object","properties":{"id":{"type":"string"},"dueType":{"type":"number","nullable":true},"dueDays":{"type":"number","nullable":true},"discountPercent":{"type":"string","nullable":true}},"required":["id","dueType","dueDays","discountPercent"],"additionalProperties":false},"Salesperson":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"employeeId":{"type":"string","nullable":true},"inactive":{"type":"boolean"}},"required":["id","firstName","lastName","employeeId","inactive"],"additionalProperties":false},"FiscalPeriod":{"type":"object","properties":{"year":{"type":"number","nullable":true},"period":{"type":"number","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"series":{"type":"number","nullable":true},"closed":{"type":"boolean"}},"required":["year","period","startDate","endDate","series","closed"],"additionalProperties":false},"Batch":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","nullable":true},"series":{"type":"number","nullable":true},"transactionCount":{"type":"number","nullable":true},"total":{"type":"string","nullable":true},"markedToPost":{"type":"boolean"},"postingDate":{"type":"string","nullable":true}},"required":["id","source","series","transactionCount","total","markedToPost","postingDate"],"additionalProperties":false}}},"paths":{"/v1/companies":{"get":{"operationId":"list_companies","tags":["companies"],"summary":"List companies","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of companies.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/companies/{id}":{"get":{"operationId":"get_companies","tags":["companies"],"summary":"Get one companies by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested companies.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Company"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customers":{"get":{"operationId":"list_customers","tags":["customers"],"summary":"List customers","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"classId","in":"query","required":false,"schema":{"type":"string"}},{"name":"inactive","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"updatedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of customers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customers/{id}":{"get":{"operationId":"get_customers","tags":["customers"],"summary":"Get one customers by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested customers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customer-addresses":{"get":{"operationId":"list_customer_addresses","tags":["customer-addresses"],"summary":"List customer-addresses","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"A keyset-paginated page of customer-addresses.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddress"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customer-addresses/{id}":{"get":{"operationId":"get_customer_addresses","tags":["customer-addresses"],"summary":"Get one customer-addresses by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested customer-addresses.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerAddress"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/vendors":{"get":{"operationId":"list_vendors","tags":["vendors"],"summary":"List vendors","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"classId","in":"query","required":false,"schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of vendors.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Vendor"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/vendors/{id}":{"get":{"operationId":"get_vendors","tags":["vendors"],"summary":"Get one vendors by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested vendors.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Vendor"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/vendor-addresses":{"get":{"operationId":"list_vendor_addresses","tags":["vendor-addresses"],"summary":"List vendor-addresses","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"vendorId","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"A keyset-paginated page of vendor-addresses.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VendorAddress"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/vendor-addresses/{id}":{"get":{"operationId":"get_vendor_addresses","tags":["vendor-addresses"],"summary":"Get one vendor-addresses by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested vendor-addresses.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VendorAddress"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/items":{"get":{"operationId":"list_items","tags":["items"],"summary":"List items","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"classId","in":"query","required":false,"schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of items.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/items/{id}":{"get":{"operationId":"get_items","tags":["items"],"summary":"Get one items by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested items.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Item"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/item-quantities":{"get":{"operationId":"list_item_quantities","tags":["item-quantities"],"summary":"List item-quantities","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemId","in":"query","required":false,"schema":{"type":"string"}},{"name":"siteId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of item-quantities.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemQuantity"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/item-quantities/{id}":{"get":{"operationId":"get_item_quantities","tags":["item-quantities"],"summary":"Get one item-quantities by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested item-quantities.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ItemQuantity"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/accounts":{"get":{"operationId":"list_accounts","tags":["accounts"],"summary":"List accounts","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"active","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"A keyset-paginated page of accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/accounts/{id}":{"get":{"operationId":"get_accounts","tags":["accounts"],"summary":"Get one accounts by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Account"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/gl-entries":{"get":{"operationId":"list_gl_entries","tags":["gl-entries"],"summary":"List gl-entries","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"year","in":"query","required":false,"schema":{"type":"string","enum":["open","history"]}},{"name":"accountNumber","in":"query","required":false,"schema":{"type":"string"}},{"name":"journalEntryNumber","in":"query","required":false,"schema":{"type":"integer"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of gl-entries.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GlEntry"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ar-invoices":{"get":{"operationId":"list_ar_invoices","tags":["ar-invoices"],"summary":"List ar-invoices","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","history"]}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dueBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of ar-invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ArDocument"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ar-invoices/{id}":{"get":{"operationId":"get_ar_invoices","tags":["ar-invoices"],"summary":"Get one ar-invoices by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested ar-invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ArDocument"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ar-payments":{"get":{"operationId":"list_ar_payments","tags":["ar-payments"],"summary":"List ar-payments","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","history"]}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dueBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of ar-payments.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ArDocument"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ar-payments/{id}":{"get":{"operationId":"get_ar_payments","tags":["ar-payments"],"summary":"Get one ar-payments by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested ar-payments.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ArDocument"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ap-invoices":{"get":{"operationId":"list_ap_invoices","tags":["ap-invoices"],"summary":"List ap-invoices","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","history"]}},{"name":"vendorId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dueBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of ap-invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApDocument"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ap-invoices/{id}":{"get":{"operationId":"get_ap_invoices","tags":["ap-invoices"],"summary":"Get one ap-invoices by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested ap-invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApDocument"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ap-payments":{"get":{"operationId":"list_ap_payments","tags":["ap-payments"],"summary":"List ap-payments","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","history"]}},{"name":"vendorId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dueBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of ap-payments.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApDocument"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/ap-payments/{id}":{"get":{"operationId":"get_ap_payments","tags":["ap-payments"],"summary":"Get one ap-payments by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested ap-payments.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApDocument"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sales-orders":{"get":{"operationId":"list_sales_orders","tags":["sales-orders"],"summary":"List sales-orders","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["work","history"]}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of sales-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SalesOrder"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sales-orders/{id}":{"get":{"operationId":"get_sales_orders","tags":["sales-orders"],"summary":"Get one sales-orders by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested sales-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SalesOrder"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sales-orders/{id}/lines":{"get":{"operationId":"lines_sales_orders","tags":["sales-orders"],"summary":"List the lines of one sales-orders","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The lines of the sales-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SalesOrderLine"}}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/purchase-orders":{"get":{"operationId":"list_purchase_orders","tags":["purchase-orders"],"summary":"List purchase-orders","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"vendorId","in":"query","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A keyset-paginated page of purchase-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrder"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/purchase-orders/{id}":{"get":{"operationId":"get_purchase_orders","tags":["purchase-orders"],"summary":"Get one purchase-orders by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested purchase-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PurchaseOrder"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/purchase-orders/{id}/lines":{"get":{"operationId":"lines_purchase_orders","tags":["purchase-orders"],"summary":"List the lines of one purchase-orders","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The lines of the purchase-orders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLine"}}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sites":{"get":{"operationId":"list_sites","tags":["sites"],"summary":"List sites","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of sites.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sites/{id}":{"get":{"operationId":"get_sites","tags":["sites"],"summary":"Get one sites by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested sites.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Site"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checkbooks":{"get":{"operationId":"list_checkbooks","tags":["checkbooks"],"summary":"List checkbooks","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of checkbooks.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Checkbook"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checkbooks/{id}":{"get":{"operationId":"get_checkbooks","tags":["checkbooks"],"summary":"Get one checkbooks by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested checkbooks.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Checkbook"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/payment-terms":{"get":{"operationId":"list_payment_terms","tags":["payment-terms"],"summary":"List payment-terms","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of payment-terms.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentTerm"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/payment-terms/{id}":{"get":{"operationId":"get_payment_terms","tags":["payment-terms"],"summary":"Get one payment-terms by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested payment-terms.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentTerm"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/salespeople":{"get":{"operationId":"list_salespeople","tags":["salespeople"],"summary":"List salespeople","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of salespeople.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Salesperson"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/salespeople/{id}":{"get":{"operationId":"get_salespeople","tags":["salespeople"],"summary":"Get one salespeople by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested salespeople.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Salesperson"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/fiscal-periods":{"get":{"operationId":"list_fiscal_periods","tags":["fiscal-periods"],"summary":"List fiscal-periods","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"year","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"A keyset-paginated page of fiscal-periods.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FiscalPeriod"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/batches":{"get":{"operationId":"list_batches","tags":["batches"],"summary":"List batches","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A keyset-paginated page of batches.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Batch"}},"nextCursor":{"type":"string","nullable":true}},"required":["data","nextCursor"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/batches/{id}":{"get":{"operationId":"get_batches","tags":["batches"],"summary":"Get one batches by id","security":[{"bearerAuth":[]}],"parameters":[{"name":"X-Connection-Id","in":"header","required":true,"description":"The connection (end-customer GP install) to route this read to.","schema":{"type":"string"}},{"name":"X-Company","in":"header","required":false,"description":"GP company database id. Defaults to the connection's default company.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The object id (see 06 for composite-id objects, e.g. `type:documentNumber`).","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested batches.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Batch"}},"required":["data"]}}}},"400":{"description":"Invalid query, cursor, or missing/invalid X-Company / X-Connection-Id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No object with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see X-RateLimit-* and Retry-After).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The connection's agent is offline (CONNECTION_OFFLINE) or GP is unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}