Invoice service (2.0.0)

Download OpenAPI specification:Download

E-mail: support@fabric.inc License: fabric privacy policy Terms of Service

fabric OMS Invoice APIs for multinenat service

Invoice Controller

These endpoints help in generating the invoices

Generate invoice

Generates invoice for the given invoice type such as, shipment, appeasement, and so on.

SecurityAuthorization or context

Request

header Parameters

required

object (XSiteContext)

x-site-context value

Request Body schema: application/json

detailType required	string Event type
	object (InvoiceEventDetail) Invoice event detail model

Responses

201

Invoice generated

400

Bad Request

404

Not found

500

Internal Server Error

post/

Request samples

Payload

application/json

{"detailType": "ORDER_CREATE/ORDER_RETURNS",
"detail": {"orderNumber": "ship1233234555g",
"channel": "ship1233234555g",
"tenant": "ship1233234555g",
"id": "ship1233234555g",
"documentType": "ORDER",
"invoiceType": "SHIPMENT"
}
}

Response samples

application/json

{"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoiceStatus": "CAPTURED/SETTLED",
"invoiceType": "SHIPPING/APPEASEMENT",
"invoiceDate": "2022-08-01T20:03:28.483971941Z",
"shipmentId": "62ff5c0bec0aed3c86202c32",
"shipmentNumber": "217088603",
"shippedOn": "2022-08-01T20:03:28.483971941Z",
"orders": [{"orderId": "62ff5c0bec0aed3c86202c32",
"orderNumber": "217088603",
"orderDate": "2022-05-12T09:30:31.198Z",
"orderType": "WEB",
"orderSubType": "International",
"invoiceOrderTotal": 245.7,
"items": [{"lineItemId": "1adfrghhh2346aaaf",
"lineItemNumber": 1,
"shipmentLineItemId": "string",
"itemId": "1234",
"orderId": "string",
"type": "WEB_PICKUP",
"sku": "P1234",
"invoiceQuantity": 10,
"itemUnitPrice": 0,
"invoiceLineTotal": 600,
"itemDiscountsTotal": 0,
"itemTaxTotal": 0,
"itemFeeTotal": 0,
"itemAppeasementTotal": 0,
"lineItemCreatedAt": "2019-08-24T14:15:22Z",
"locationStoreId": "string",
"returnExpiryDays": "string",
"currency": "string",
"fees": [{"type": "tax",
"value": 34.56
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [null
]
}
],
"discount": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"shipToId": "5349b4ddd2781d08c09890f4",
"returns": [{"shipmentLineItemId": "string",
"shipmentQuantity": 0,
"refundAmount": 0,
"reasonCode": "string",
"invoiceDate": "2019-08-24T14:15:22Z"
}
],
"attributes": {"property1": { },
"property2": { }
},
"uom": "string"
}
],
"payments": [{"paymentCounter": 0,
"paymentDate": "2022-01-27T16:15:58.000-05:00",
"billToId": "62272e917b12209e68751d94",
"paymentIdentifier": {"cardIdentifier": "***********3456"
},
"paymentProvider": "stripe",
"paymentToken": {"token": "pi_34tr6787rt"
},
"paymentMethod": "CREDIT_CARD",
"paymentType": "VISA",
"currency": "USD",
"conversion": 1,
"paymentStatus": "OK",
"attributes": {"property1": { },
"property2": { }
},
"billToAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": null,
"email": null,
"phone": [ ],
"name": null
}
]
},
"settlement": {"settlementDate": "2022-01-27T16:15:58-05:00",
"settlementStatusCode": "SETTLED",
"settlementAmount": 0,
"attributes": {"property1": { },
"property2": { }
}
},
"authAmount": 0
}
],
"fees": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [{"paymentCounter": 1,
"refundAmount": 40
}
]
}
],
"discounts": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"locationNum": 3235,
"location": "object",
"retail": {"locationNum": 0,
"cashierId": "string"
},
"createdAt": "2022-08-01T20:03:28.483971941Z",
"updatedAt": "2022-08-01T20:03:28.483971941Z",
"postedAt": "2022-08-01T20:03:28.483971941Z",
"acknowledgedAt": "2022-08-01T20:03:28.483971941Z",
"statusCode": "CREATED/POSTED/ACKNOWLEDGED",
"channelId": "strate",
"invoiceTotal": 245.7,
"totalTaxAmount": 245.7,
"currency": "dollar",
"customer": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Fabric",
"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": "string",
"email": "string",
"phone": [{"number": "string",
"type": "string"
}
],
"name": {"first": "string",
"middle": "string",
"last": "string"
}
}
]
}
},
"auditLogs": [{"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "62272e917b12209e68751d94",
"auditType": "string",
"employeeId": "62272e917b12209e68751d94",
"auditTimestamp": "2022-05-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "POS",
"subReasonCode": "POS",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "F5F",
"quantity": 1,
"amount": 2.4,
"paymentToken": {"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"success": true,
"paymentResponse": { },
"updatedFields": [{"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"shipInfo": {"shipToId": "5349b4ddd2781d08c09890f4",
"taxCode": "FR01",
"locationNum": "123",
"pickup": [{"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"pickupType": "Primary"
}
],
"shipToAddress": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"address1": "Test Street",
"address2": "123 Parking Lot",
"address3": "string",
"address4": "string",
"city": "Beaumont",
"state": "TX",
"country": "USA",
"postalCode": "77705",
"type": "residence",
"latitude": 35.294952,
"longitude": 32.294952
},
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"shipMethod": "Express Delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"shipToTaxTotal": 12.6,
"shipmentInstructions": "User Instructions",
"attributes": {"property1": { },
"property2": { }
}
},
"attributes": {"property1": { },
"property2": { }
}
}

Get invoice by query

Retrieves invoice by query

SecurityAuthorization or context

Request

header Parameters

required

object (XSiteContext)

x-site-context value

Request Body schema: application/json

limit	integer <int32> Default: 10 Numbers of records to be returned.
offset	integer <int64> Default: 0 Number of records to skipped.
sortBy	string Default: "updatedAt" Item property on which data needed to be sorted on.
sortDirection	string Default: "desc" Direction of sorting i.e ascending or descending Enum: "asc" "desc"
required	object Default: {} JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

Responses

200

Invoice fetched

400

Bad Request

404

Invoice not found

500

Internal Server Error

post/query

Request samples

Payload

application/json

{"limit": 10,
"offset": 0,
"sortBy": "updatedAt",
"sortDirection": "desc",
"filters": {"retail": {"locationNum": 12
},
"orderSubTotal": {"gte": 1300,
"lt": 1400
},
"orderNumber": "order-*Z",
"statusCode": ["ORDER_CREATED"
],
"createdAt": {"lt": "2022-09-11T23:12:00.123Z"
},
"shipInfo": {"shipToId": ["23434",
"23436"
]
}
}
}

Response samples

application/json

{"count": 100,
"limit": 10,
"offset": 1
}

Update invoice for financial posting

Updates invoice for financial posting for invoice IDs

SecurityAuthorization or context

Request

header Parameters

required

object (XSiteContext)

x-site-context value

Request Body schema: application/json

invoiceIds

required

Array of strings

List of invoiceIds

Responses

201

Invoice updated

400

Bad Request

404

Invoice not found

500

Internal Server Error

post/post

Request samples

Payload

application/json

{"invoiceIds": ["invoiceId1",
"invoiceId2"
]
}

Response samples

application/json

[{"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoiceStatus": "CAPTURED/SETTLED",
"invoiceType": "SHIPPING/APPEASEMENT",
"invoiceDate": "2022-08-01T20:03:28.483971941Z",
"shipmentId": "62ff5c0bec0aed3c86202c32",
"shipmentNumber": "217088603",
"shippedOn": "2022-08-01T20:03:28.483971941Z",
"orders": [{"orderId": "62ff5c0bec0aed3c86202c32",
"orderNumber": "217088603",
"orderDate": "2022-05-12T09:30:31.198Z",
"orderType": "WEB",
"orderSubType": "International",
"invoiceOrderTotal": 245.7,
"items": [{"lineItemId": "1adfrghhh2346aaaf",
"lineItemNumber": 1,
"shipmentLineItemId": "string",
"itemId": "1234",
"orderId": "string",
"type": "WEB_PICKUP",
"sku": "P1234",
"invoiceQuantity": 10,
"itemUnitPrice": 0,
"invoiceLineTotal": 600,
"itemDiscountsTotal": 0,
"itemTaxTotal": 0,
"itemFeeTotal": 0,
"itemAppeasementTotal": 0,
"lineItemCreatedAt": "2019-08-24T14:15:22Z",
"locationStoreId": "string",
"returnExpiryDays": "string",
"currency": "string",
"fees": [{"type": null,
"value": null
}
],
"taxDetail": [{"type": null,
"value": null
}
],
"appeasements": [{"appeasementCounter": null,
"reasonCode": null,
"subReasonCode": null,
"value": null,
"invoiceValue": null,
"payments": [ ]
}
],
"discount": [{"quantity": null,
"value": null,
"promoId": null,
"promoCode": null,
"promoTitle": null,
"type": null
}
],
"shipToId": "5349b4ddd2781d08c09890f4",
"returns": [{"shipmentLineItemId": null,
"shipmentQuantity": null,
"refundAmount": null,
"reasonCode": null,
"invoiceDate": null
}
],
"attributes": {"property1": { },
"property2": { }
},
"uom": "string"
}
],
"payments": [{"paymentCounter": 0,
"paymentDate": "2022-01-27T16:15:58.000-05:00",
"billToId": "62272e917b12209e68751d94",
"paymentIdentifier": {"cardIdentifier": "***********3456"
},
"paymentProvider": "stripe",
"paymentToken": {"token": "pi_34tr6787rt"
},
"paymentMethod": "CREDIT_CARD",
"paymentType": "VISA",
"currency": "USD",
"conversion": 1,
"paymentStatus": "OK",
"attributes": {"property1": { },
"property2": { }
},
"billToAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [null
]
},
"settlement": {"settlementDate": "2022-01-27T16:15:58-05:00",
"settlementStatusCode": "SETTLED",
"settlementAmount": 0,
"attributes": {"property1": { },
"property2": { }
}
},
"authAmount": 0
}
],
"fees": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [{"paymentCounter": null,
"refundAmount": null
}
]
}
],
"discounts": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"locationNum": 3235,
"location": "object",
"retail": {"locationNum": 0,
"cashierId": "string"
},
"createdAt": "2022-08-01T20:03:28.483971941Z",
"updatedAt": "2022-08-01T20:03:28.483971941Z",
"postedAt": "2022-08-01T20:03:28.483971941Z",
"acknowledgedAt": "2022-08-01T20:03:28.483971941Z",
"statusCode": "CREATED/POSTED/ACKNOWLEDGED",
"channelId": "strate",
"invoiceTotal": 245.7,
"totalTaxAmount": 245.7,
"currency": "dollar",
"customer": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Fabric",
"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": "string",
"email": "string",
"phone": [{"number": null,
"type": null
}
],
"name": {"first": "string",
"middle": "string",
"last": "string"
}
}
]
}
},
"auditLogs": [{"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "62272e917b12209e68751d94",
"auditType": "string",
"employeeId": "62272e917b12209e68751d94",
"auditTimestamp": "2022-05-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "POS",
"subReasonCode": "POS",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "F5F",
"quantity": 1,
"amount": 2.4,
"paymentToken": {"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"success": true,
"paymentResponse": { },
"updatedFields": [{"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"shipInfo": {"shipToId": "5349b4ddd2781d08c09890f4",
"taxCode": "FR01",
"locationNum": "123",
"pickup": [{"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"pickupType": "Primary"
}
],
"shipToAddress": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"address1": "Test Street",
"address2": "123 Parking Lot",
"address3": "string",
"address4": "string",
"city": "Beaumont",
"state": "TX",
"country": "USA",
"postalCode": "77705",
"type": "residence",
"latitude": 35.294952,
"longitude": 32.294952
},
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"shipMethod": "Express Delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"shipToTaxTotal": 12.6,
"shipmentInstructions": "User Instructions",
"attributes": {"property1": { },
"property2": { }
}
},
"attributes": {"property1": { },
"property2": { }
}
}
]

Acknowledge financial posting

Acknowledges financial posting for invoice ID

SecurityAuthorization or context

Request

header Parameters

required

object (XSiteContext)

x-site-context value

Request Body schema: application/json

invoiceId required	string Invoice Id
acknowledgedAt required	string <date-time> Date when invoice acknowledged for financial posting
attributes	object Attributes

Responses

201

Acknowledged financial posting

400

Bad Request

404

Invoice not found

500

Internal Server Error

post/post/acknowledge

Request samples

Payload

application/json

{"invoiceId": "123ab",
"acknowledgedAt": "2022-08-01T20:03:28.483971941Z",
"attributes": { }
}

Response samples

application/json

{"message": "Success"
}

Acknowledge invoice by ID

Acknowledges invoice by invoice ID

SecurityAuthorization or context

Request

header Parameters

required

object (XSiteContext)

x-site-context value

Request Body schema: application/json

invoiceId

required

string

Invoice Id

Responses

201

Invoice acknowledged

400

Bad Request

404

Invoice not found

500

Internal Server Error

post/acknowledgement

Request samples

Payload

application/json

{"invoiceId": "123"
}

Response samples

application/json

{"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoiceStatus": "CAPTURED/SETTLED",
"invoiceType": "SHIPPING/APPEASEMENT",
"invoiceDate": "2022-08-01T20:03:28.483971941Z",
"shipmentId": "62ff5c0bec0aed3c86202c32",
"shipmentNumber": "217088603",
"shippedOn": "2022-08-01T20:03:28.483971941Z",
"orders": [{"orderId": "62ff5c0bec0aed3c86202c32",
"orderNumber": "217088603",
"orderDate": "2022-05-12T09:30:31.198Z",
"orderType": "WEB",
"orderSubType": "International",
"invoiceOrderTotal": 245.7,
"items": [{"lineItemId": "1adfrghhh2346aaaf",
"lineItemNumber": 1,
"shipmentLineItemId": "string",
"itemId": "1234",
"orderId": "string",
"type": "WEB_PICKUP",
"sku": "P1234",
"invoiceQuantity": 10,
"itemUnitPrice": 0,
"invoiceLineTotal": 600,
"itemDiscountsTotal": 0,
"itemTaxTotal": 0,
"itemFeeTotal": 0,
"itemAppeasementTotal": 0,
"lineItemCreatedAt": "2019-08-24T14:15:22Z",
"locationStoreId": "string",
"returnExpiryDays": "string",
"currency": "string",
"fees": [{"type": "tax",
"value": 34.56
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [null
]
}
],
"discount": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"shipToId": "5349b4ddd2781d08c09890f4",
"returns": [{"shipmentLineItemId": "string",
"shipmentQuantity": 0,
"refundAmount": 0,
"reasonCode": "string",
"invoiceDate": "2019-08-24T14:15:22Z"
}
],
"attributes": {"property1": { },
"property2": { }
},
"uom": "string"
}
],
"payments": [{"paymentCounter": 0,
"paymentDate": "2022-01-27T16:15:58.000-05:00",
"billToId": "62272e917b12209e68751d94",
"paymentIdentifier": {"cardIdentifier": "***********3456"
},
"paymentProvider": "stripe",
"paymentToken": {"token": "pi_34tr6787rt"
},
"paymentMethod": "CREDIT_CARD",
"paymentType": "VISA",
"currency": "USD",
"conversion": 1,
"paymentStatus": "OK",
"attributes": {"property1": { },
"property2": { }
},
"billToAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": null,
"email": null,
"phone": [ ],
"name": null
}
]
},
"settlement": {"settlementDate": "2022-01-27T16:15:58-05:00",
"settlementStatusCode": "SETTLED",
"settlementAmount": 0,
"attributes": {"property1": { },
"property2": { }
}
},
"authAmount": 0
}
],
"fees": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [{"paymentCounter": 1,
"refundAmount": 40
}
]
}
],
"discounts": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"locationNum": 3235,
"location": "object",
"retail": {"locationNum": 0,
"cashierId": "string"
},
"createdAt": "2022-08-01T20:03:28.483971941Z",
"updatedAt": "2022-08-01T20:03:28.483971941Z",
"postedAt": "2022-08-01T20:03:28.483971941Z",
"acknowledgedAt": "2022-08-01T20:03:28.483971941Z",
"statusCode": "CREATED/POSTED/ACKNOWLEDGED",
"channelId": "strate",
"invoiceTotal": 245.7,
"totalTaxAmount": 245.7,
"currency": "dollar",
"customer": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Fabric",
"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": "string",
"email": "string",
"phone": [{"number": "string",
"type": "string"
}
],
"name": {"first": "string",
"middle": "string",
"last": "string"
}
}
]
}
},
"auditLogs": [{"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "62272e917b12209e68751d94",
"auditType": "string",
"employeeId": "62272e917b12209e68751d94",
"auditTimestamp": "2022-05-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "POS",
"subReasonCode": "POS",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "F5F",
"quantity": 1,
"amount": 2.4,
"paymentToken": {"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"success": true,
"paymentResponse": { },
"updatedFields": [{"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"shipInfo": {"shipToId": "5349b4ddd2781d08c09890f4",
"taxCode": "FR01",
"locationNum": "123",
"pickup": [{"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"pickupType": "Primary"
}
],
"shipToAddress": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"address1": "Test Street",
"address2": "123 Parking Lot",
"address3": "string",
"address4": "string",
"city": "Beaumont",
"state": "TX",
"country": "USA",
"postalCode": "77705",
"type": "residence",
"latitude": 35.294952,
"longitude": 32.294952
},
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"shipMethod": "Express Delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"shipToTaxTotal": 12.6,
"shipmentInstructions": "User Instructions",
"attributes": {"property1": { },
"property2": { }
}
},
"attributes": {"property1": { },
"property2": { }
}
}

Get invoice by invoice ID

Retrieves invoice by invoice ID

SecurityAuthorization or context

Request

path Parameters

invoiceId

required

string

header Parameters

required

object (XSiteContext)

x-site-context value

Responses

200

Invoice fetched

400

Bad Request

404

Invoice not found

500

Internal Server Error

get/{invoiceId}

Response samples

application/json

{"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoiceStatus": "CAPTURED/SETTLED",
"invoiceType": "SHIPPING/APPEASEMENT",
"invoiceDate": "2022-08-01T20:03:28.483971941Z",
"shipmentId": "62ff5c0bec0aed3c86202c32",
"shipmentNumber": "217088603",
"shippedOn": "2022-08-01T20:03:28.483971941Z",
"orders": [{"orderId": "62ff5c0bec0aed3c86202c32",
"orderNumber": "217088603",
"orderDate": "2022-05-12T09:30:31.198Z",
"orderType": "WEB",
"orderSubType": "International",
"invoiceOrderTotal": 245.7,
"items": [{"lineItemId": "1adfrghhh2346aaaf",
"lineItemNumber": 1,
"shipmentLineItemId": "string",
"itemId": "1234",
"orderId": "string",
"type": "WEB_PICKUP",
"sku": "P1234",
"invoiceQuantity": 10,
"itemUnitPrice": 0,
"invoiceLineTotal": 600,
"itemDiscountsTotal": 0,
"itemTaxTotal": 0,
"itemFeeTotal": 0,
"itemAppeasementTotal": 0,
"lineItemCreatedAt": "2019-08-24T14:15:22Z",
"locationStoreId": "string",
"returnExpiryDays": "string",
"currency": "string",
"fees": [{"type": "tax",
"value": 34.56
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [null
]
}
],
"discount": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"shipToId": "5349b4ddd2781d08c09890f4",
"returns": [{"shipmentLineItemId": "string",
"shipmentQuantity": 0,
"refundAmount": 0,
"reasonCode": "string",
"invoiceDate": "2019-08-24T14:15:22Z"
}
],
"attributes": {"property1": { },
"property2": { }
},
"uom": "string"
}
],
"payments": [{"paymentCounter": 0,
"paymentDate": "2022-01-27T16:15:58.000-05:00",
"billToId": "62272e917b12209e68751d94",
"paymentIdentifier": {"cardIdentifier": "***********3456"
},
"paymentProvider": "stripe",
"paymentToken": {"token": "pi_34tr6787rt"
},
"paymentMethod": "CREDIT_CARD",
"paymentType": "VISA",
"currency": "USD",
"conversion": 1,
"paymentStatus": "OK",
"attributes": {"property1": { },
"property2": { }
},
"billToAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": null,
"email": null,
"phone": [ ],
"name": null
}
]
},
"settlement": {"settlementDate": "2022-01-27T16:15:58-05:00",
"settlementStatusCode": "SETTLED",
"settlementAmount": 0,
"attributes": {"property1": { },
"property2": { }
}
},
"authAmount": 0
}
],
"fees": [{"type": "tax",
"value": 34.56
}
],
"appeasements": [{"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"value": 34.56,
"invoiceValue": 34.56,
"payments": [{"paymentCounter": 1,
"refundAmount": 40
}
]
}
],
"discounts": [{"quantity": 2,
"value": 2,
"promoId": "HNY2022",
"promoCode": "HNY2022",
"promoTitle": "Happy New Year",
"type": "promotion"
}
],
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"locationNum": 3235,
"location": "object",
"retail": {"locationNum": 0,
"cashierId": "string"
},
"createdAt": "2022-08-01T20:03:28.483971941Z",
"updatedAt": "2022-08-01T20:03:28.483971941Z",
"postedAt": "2022-08-01T20:03:28.483971941Z",
"acknowledgedAt": "2022-08-01T20:03:28.483971941Z",
"statusCode": "CREATED/POSTED/ACKNOWLEDGED",
"channelId": "strate",
"invoiceTotal": 245.7,
"totalTaxAmount": 245.7,
"currency": "dollar",
"customer": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Fabric",
"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"type": "string",
"contact": [{"type": "string",
"email": "string",
"phone": [{"number": "string",
"type": "string"
}
],
"name": {"first": "string",
"middle": "string",
"last": "string"
}
}
]
}
},
"auditLogs": [{"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "62272e917b12209e68751d94",
"auditType": "string",
"employeeId": "62272e917b12209e68751d94",
"auditTimestamp": "2022-05-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "POS",
"subReasonCode": "POS",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "F5F",
"quantity": 1,
"amount": 2.4,
"paymentToken": {"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"success": true,
"paymentResponse": { },
"updatedFields": [{"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"attributes": {"property1": { },
"property2": { }
}
}
],
"shipInfo": {"shipToId": "5349b4ddd2781d08c09890f4",
"taxCode": "FR01",
"locationNum": "123",
"pickup": [{"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"pickupType": "Primary"
}
],
"shipToAddress": {"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "test@fabric.inc",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"address1": "Test Street",
"address2": "123 Parking Lot",
"address3": "string",
"address4": "string",
"city": "Beaumont",
"state": "TX",
"country": "USA",
"postalCode": "77705",
"type": "residence",
"latitude": 35.294952,
"longitude": 32.294952
},
"taxDetail": [{"type": "tax",
"value": 34.56
}
],
"shipMethod": "Express Delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"shipToTaxTotal": 12.6,
"shipmentInstructions": "User Instructions",
"attributes": {"property1": { },
"property2": { }
}
},
"attributes": {"property1": { },
"property2": { }
}
}